Orders (DOMS)
all entities after given Id
number of entities to show
25filter orders by tenantOrderId
filter orders by consumerId
Orders are found.
StrippedOrders
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
OrderForCreation
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZDefines the source of this order. This field is not required, if the order is created based on an external system.
The state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The order was successfully created. The Location header contains the URL of the order.
Invalid input. See response for details
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of order you want to get
Order was found & you were allowed to access it. The result is in the body.
VersionedResource
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZDefines the source of this order. This field is not required, if the order is created based on an external system.
The state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Indicates if gdpr related data was anonymized
falseThe id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found
ID of Order you want to patch
OrderForUpdate
A comment for updating this order.
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.
2025-01-15T00:00:00.000ZThe version of the document to be used in optimistic locking mechanisms.
42Order was found & patch-set has been applied. The patched entity is in the body.
VersionedResource
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZDefines the source of this order. This field is not required, if the order is created based on an external system.
The state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Indicates if gdpr related data was anonymized
falseThe id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Entity not found, for more information please look at details.
Reference to the order you want to call the action for
OrderActionsParameter
Updated Order in the body.
VersionedResource
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZDefines the source of this order. This field is not required, if the order is created based on an external system.
The state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Indicates if gdpr related data was anonymized
falseThe id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Order not found or expired
Reference to the order you want to call the action for
Reference to the order line item you want to call the action for
OrderLineItemActionsParameter
Updated Order in the body.
VersionedResource
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZDefines the source of this order. This field is not required, if the order is created based on an external system.
The state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Indicates if gdpr related data was anonymized
falseThe id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.
LGMl2DuvPnfPoSHhYFOmId of the global process related to this entity. For example used for starting the GDPR process and others.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
OrderSearchPayload
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
OrderPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
PromiseRequest
Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZThe state of the order. Initially it is OPEN.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546The order promise was created URL of the order promse.
Invalid input. See response for details
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Last updated