Start preparing an order

PUT

/api/tenant/{tenantId}/Orders/{id}/startpreparing

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/startpreparing"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"message\": \"example\", \"notifyCustomer\": true, \"assignToUserId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"estimatedEnd\": \"2026-04-15T12:00:00Z\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/startpreparing';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","message":"example","notifyCustomer":true,"assignToUserId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","estimatedEnd":"2026-04-15T12:00:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/startpreparing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "message": "example", "notifyCustomer": true, "assignToUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "estimatedEnd": "2026-04-15T12:00:00Z" }'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

tenantId

required

string format: uuid

Your tenant id.

Request Body

application/json

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

message

string

nullable

notifyCustomer

boolean

assignToUserId

string format: uuid

nullable

estimatedEnd

string format: date-time

nullable

Example ^generated

{
  "fields": {
    "additionalProperty": {
      "value": "example",
      "valueType": "example"
    }
  },
  "accessibility": "example",
  "message": "example",
  "notifyCustomer": true,
  "assignToUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "estimatedEnd": "2026-04-15T12:00:00Z"
}

Responses

200

application/json

object

fields

object

key

additional properties

string

data

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

relations

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

name

string

nullable

entityId

required

string format: uuid

entityType

required

string

>= 1 characters

relationType

required

string

>= 1 characters

tenantId

string format: uuid

nullable

resourceGroupId

string format: uuid

nullable

creatorId

string format: uuid

nullable

createdDate

string format: date-time

nullable

version

integer format: int32

nullable

lastModified

string format: date-time

nullable

head

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

parentOrderId

string format: uuid

nullable

relationshipId

string format: uuid

nullable

cartId

string format: uuid

nullable

discountId

string format: uuid

nullable

deliveryOptionId

string format: uuid

nullable

paymentOptionId

string format: uuid

nullable

assignedToUserId

string format: uuid

nullable

paymentIds

Array<string>

nullable

deliveryIds

Array<string>

nullable

externalOrderNumber

string

nullable

orderNumber

integer format: int32

discountCode

string

nullable

discountType

string

nullable

discountValue

number format: double

nullable

discountStartDate

string format: date-time

nullable

discountStopDate

string format: date-time

nullable

discountMinOrderValue

number format: double

nullable

archivedByBuyer

boolean

archivedBySeller

boolean

totalGrossDiscount

number format: double

totalGrossPrice

number format: double

totalVat

number format: double

totalNetDiscount

number format: double

totalNetPrice

number format: double

buyer

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

organizationId

string format: uuid

nullable

userId

string format: uuid

nullable

siteId

string format: uuid

nullable

customerType

string

nullable

identityNumber

string

nullable

organizationName

string

nullable

firstName

string

nullable

lastName

string

nullable

email

string

nullable

phoneNumber

string

nullable

deliveryAddress

object

coAddress

string

nullable

state

string

nullable

country

string

nullable

name

string

nullable

firstName

string

nullable

lastName

string

nullable

street

string

nullable

postalCode

string

nullable

city

string

nullable

billingAddress

object

coAddress

string

nullable

state

string

nullable

country

string

nullable

name

string

nullable

firstName

string

nullable

lastName

string

nullable

street

string

nullable

postalCode

string

nullable

city

string

nullable

useDeliveryAddress

boolean

seller

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

organizationId

string format: uuid

nullable

userId

string format: uuid

nullable

siteId

string format: uuid

nullable

deliveryType

string

nullable

paymentType

string

nullable

orderStatus

string

nullable

message

string

nullable

currency

string

nullable

orderDate

string format: date-time

nullable

deliveryDate

string format: date-time

nullable

requestedEarliestStart

string format: date-time

nullable

requestedLatestStart

string format: date-time

nullable

estimatedStart

string format: date-time

nullable

requestedEarliestEnd

string format: date-time

nullable

requestedLatestEnd

string format: date-time

nullable

estimatedEnd

string format: date-time

nullable

bySeller

boolean

lines

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

productId

string format: uuid

nullable

variantId

string format: uuid

nullable

categoryId

string format: uuid

nullable

productGroupId

string format: uuid

nullable

connectedOrderLineId

string format: uuid

nullable

parentOrderLineId

string format: uuid

nullable

scheduleId

string format: uuid

nullable

scheduleDateTime

string format: date-time

nullable

sku

string

nullable

gtin

string

nullable

name

string

nullable

additionalName

string

nullable

description

string

nullable

orderItemType

string

nullable

quantity

number format: double

nullable

unitNetPrice

number format: double

nullable

unitGrossPrice

number format: double

nullable

unitDiscountNetPrice

number format: double

nullable

unitDiscountGrossPrice

number format: double

nullable

totalNetPrice

number format: double

nullable

totalGrossPrice

number format: double

nullable

totalNetDiscount

number format: double

nullable

totalGrossDiscount

number format: double

nullable

productUnitPrice

number format: double

nullable

vatRate

number format: double

nullable

fileIds

Array<string>

nullable

imageIds

Array<string>

nullable

children

Array<object> recursive

productProperties

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

productPropertyId

string format: uuid

stringValues

Array<string>

nullable

numberValues

Array<number>

nullable

locations

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

address

object

coAddress

string

nullable

state

string

nullable

country

string

nullable

name

string

nullable

firstName

string

nullable

lastName

string

nullable

street

string

nullable

postalCode

string

nullable

city

string

nullable

latitude

number format: double

nullable

longitude

number format: double

nullable

radius

integer format: int32

locationIndex

integer format: int32

orderEvents

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

string format: uuid

userId

string format: uuid

username

string

nullable

eventType

string

nullable

status

string

nullable

clientIpAddress

string

nullable

action

string

nullable

message

string

nullable

createdDate

string format: date-time

Example ^generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "head": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "parentOrderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "relationshipId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "cartId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "discountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "deliveryOptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "paymentOptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "assignedToUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "paymentIds": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ],
      "deliveryIds": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ],
      "externalOrderNumber": "example",
      "orderNumber": 1,
      "discountCode": "example",
      "discountType": "example",
      "discountValue": 1,
      "discountStartDate": "2026-04-15T12:00:00Z",
      "discountStopDate": "2026-04-15T12:00:00Z",
      "discountMinOrderValue": 1,
      "archivedByBuyer": true,
      "archivedBySeller": true,
      "totalGrossDiscount": 1,
      "totalGrossPrice": 1,
      "totalVat": 1,
      "totalNetDiscount": 1,
      "totalNetPrice": 1,
      "buyer": {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "customerType": "example",
        "identityNumber": "example",
        "organizationName": "example",
        "firstName": "example",
        "lastName": "example",
        "email": "example",
        "phoneNumber": "example",
        "deliveryAddress": {
          "coAddress": "example",
          "state": "example",
          "country": "example",
          "name": "example",
          "firstName": "example",
          "lastName": "example",
          "street": "example",
          "postalCode": "example",
          "city": "example"
        },
        "billingAddress": {
          "coAddress": "example",
          "state": "example",
          "country": "example",
          "name": "example",
          "firstName": "example",
          "lastName": "example",
          "street": "example",
          "postalCode": "example",
          "city": "example"
        },
        "useDeliveryAddress": true
      },
      "seller": {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      },
      "deliveryType": "example",
      "paymentType": "example",
      "orderStatus": "example",
      "message": "example",
      "currency": "example",
      "orderDate": "2026-04-15T12:00:00Z",
      "deliveryDate": "2026-04-15T12:00:00Z",
      "requestedEarliestStart": "2026-04-15T12:00:00Z",
      "requestedLatestStart": "2026-04-15T12:00:00Z",
      "estimatedStart": "2026-04-15T12:00:00Z",
      "requestedEarliestEnd": "2026-04-15T12:00:00Z",
      "requestedLatestEnd": "2026-04-15T12:00:00Z",
      "estimatedEnd": "2026-04-15T12:00:00Z",
      "bySeller": true
    },
    "lines": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "variantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "productGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "connectedOrderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "parentOrderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "scheduleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "scheduleDateTime": "2026-04-15T12:00:00Z",
        "sku": "example",
        "gtin": "example",
        "name": "example",
        "additionalName": "example",
        "description": "example",
        "orderItemType": "example",
        "quantity": 1,
        "unitNetPrice": 1,
        "unitGrossPrice": 1,
        "unitDiscountNetPrice": 1,
        "unitDiscountGrossPrice": 1,
        "totalNetPrice": 1,
        "totalGrossPrice": 1,
        "totalNetDiscount": 1,
        "totalGrossDiscount": 1,
        "productUnitPrice": 1,
        "vatRate": 1,
        "fileIds": [
          "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        ],
        "imageIds": [
          "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        ],
        "children": [],
        "productProperties": [
          {
            "fields": {
              "additionalProperty": {
                "value": "example",
                "valueType": "example"
              }
            },
            "accessibility": "example",
            "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "productPropertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "stringValues": [
              "example"
            ],
            "numberValues": [
              1
            ]
          }
        ]
      }
    ],
    "locations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "address": {
          "coAddress": "example",
          "state": "example",
          "country": "example",
          "name": "example",
          "firstName": "example",
          "lastName": "example",
          "street": "example",
          "postalCode": "example",
          "city": "example"
        },
        "latitude": 1,
        "longitude": 1,
        "radius": 1,
        "locationIndex": 1
      }
    ],
    "orderEvents": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "username": "example",
        "eventType": "example",
        "status": "example",
        "clientIpAddress": "example",
        "action": "example",
        "message": "example",
        "createdDate": "2026-04-15T12:00:00Z"
      }
    ]
  }
}

204

No Content: done, with no item to return.

401

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

application/json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not found: no such item in the tenant.

application/problem+json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Conflict: the item kept changing under concurrent writes; read it again and retry.

application/problem+json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Unprocessable: the body or the change is invalid. The errors are keyed by member.

application/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object

errors

object

key

additional properties

Array<string>

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}

Start preparing an order

Authorizations

Parameters

Path Parameters

Request Body

Example generated

Responses

200

Example generated

204

401

403

Example generated

404

Example generated

409

Example generated

422

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated