REST Order

List parcel service region by preset ID or get by parcel service region ID.

Create an order

/rest/orders

Request

Field Type Description
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
required
plentyId Int The plenty ID of the client that the order belongs to required
statusId Float The ID of the order status optional
ownerId Int The user ID of the order's owner optional
lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked
allowed values are unlocked, permanentlyLocked, reversibleLocked
orderItems \OrderItem[]|\Collection The order items that are associated with the order. optional array
properties \OrderProperty[]|\Collection The order properties that are associated with the order. optional array
addressRelations \AddressOrderRelation[]|\Collection The address relations for this order. optional array
relations \OrderRelationReference[]|\Collection The order relation reference instances that are associated with the order. optional array
{"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"orderItems":[{"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"countryVatId":1,"vatField":0,"vatRate":19,"orderItemName":"Awesome shoes","shippingProfileId":1,"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"priceOriginalGross":300,"surcharge":20,"discount":10,"isPercentage":true}],"properties":[{"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]}],"properties":[{"typeId":13,"value":"14"}],"addressRelations":[{"typeId":1,"addressId":18},{"typeId":2,"addressId":18}],"relations":[{"referenceType":"contact","referenceId":118,"relation":"receiver"}]}

Success 200

Field Type Description
id Int The ID of the order
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
statusId Float The ID of the order status
statusName String The name for the status ID (read only)
ownerId Int The user ID of the order's owner
createdAt String|\Carbon The date that the order was created
updatedAt String|\Carbon The date that the order was updated last
plentyId Int The plenty ID of the client that the order belongs to
locationId Int The ID of the location that the order belongs to
lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked
{"properties":[{"orderId":104,"typeId":13,"value":"14"},{"orderId":104,"typeId":2,"value":"6"},{"orderId":104,"typeId":1,"value":"1"},{"orderId":104,"typeId":17,"value":"de"}],"addressRelations":[{"orderId":104,"typeId":1,"addressId":18},{"orderId":104,"typeId":2,"addressId":18}],"addresses":[],"relations":[{"orderId":104,"referenceType":"warehouse","referenceId":1,"relation":"sender"},{"orderId":104,"referenceType":"contact","referenceId":118,"relation":"receiver"}],"dates":[],"id":104,"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","orderItems":[{"id":105,"orderId":104,"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"orderItemName":"Awesome shoes","attributeValues":"Black","shippingProfileId":1,"vatField":1,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":105,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":300,"priceOriginalNet":252.10084033613,"surcharge":20,"discount":10,"isPercentage":true,"priceGross":288,"priceNet":242.01680672269}],"properties":[{"orderItemId":105,"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]},{"id":0,"orderId":104,"typeId":6,"referrerId":0,"itemVariationId":0,"quantity":1,"orderItemName":"Shipping Costs","attributeValues":"","shippingProfileId":6,"vatField":0,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":0,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":12.9,"priceOriginalNet":10.840336134454,"priceGross":12.9,"priceNet":10.840336134454}],"properties":[]}],"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"isNet":true,"netTotal":252.86,"grossTotal":300.9,"vatTotal":0,"invoiceTotal":252.86,"paidAmount":0,"vats":[{"vatField":0,"vatAmount":19,"value":48.042857142857}]}]}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List orders by filter options

/rest/orders

Parameters

Field Type Description
orderType String Filter that restricts the search result to orders of specific order types. The id of the order types must be specified. Several order types can be entered seperated by commas. @see order model typeId
contactId Int Filter that restricts the search result to orders of one order contact. The id of the contact must be specified.
supplierId Int Filter that restricts the search result to orders that include order items with variations from a supplier. The ID of the supplier must be specified.
referrerId Double Filter that restricts the search result to orders from one order referrer. The id of the order referrer must be specified.
shippingProfileId Int Filter that restricts the search result to orders with a specific shipping profile. The id of shipping profile must be specified.
ownerUserId Int Filter that restricts the search result to orders of one owner. The user id of the owner must be specified.
warehouseId Int Filter that restricts the search result to orders with a specific main warehouse. The id of the warehouse must be specified.
isEbayPlus Bool Filter that restricts the search result to orders with ebay plus.
includedVariation Int Filter that restricts the search result to orders with a certain variation. The id of the variation must be specified.
includedItem Int Filter that restricts the search result to orders with a certain item. The id of the item must be specified.
orderIds String[] Filter that restricts the search result to orders. To list several orders the orders must be separated by comma.
externalOrderId String Filter that restricts the search result to an external order id. The external order id must be specified.
clientId Int Filter that restricts the search result to order from one client. The id of the client must be specified.
paymentStatus String Filter that restricts the search result to order with a specific payment status. Valid values are unpaid,partlyPaid,fullyPaid,overpaid. One value must be specified.
updatedAtFrom String Filter that restricts the search result to orders that were last updated on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
updatedAtTo String Filter that restricts the search result to orders that were last updated within a specified period of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
createdAtFrom String Filter that restricts the search result to orders that were created on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
createdAtTo String Filter that restricts the search result to orders that were created within a certain period of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
paidAtFrom String Filter that restricts the search result to orders that received a payment on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
paidAtTo String Filter that restricts the search result to orders that received a payment within a certain period of time. This filter can be used alone or can be combined with the paidAtFrom filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
outgoingItemsBookedAtFrom String Filter that restricts the search result to orders where the outgoing items were booked on the specified date. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
outgoingItemsBookedAtTo String Filter that restricts the search result to orders where the outgoing items were booked within a specified period of time. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.
statusFrom Double Filter that restricts the search result to orders in a specific order status. The value of the order status must be specified.
statusTo Double Filter that restricts the search result to orders within a range of order statuses. This filter can be used alone or can be combined with the statusFrom filter. The value of the order status must be specified.
hasDocument String Filter that restricts the search result to orders which hold the given document type. Valid values are multi_invoice, multi_credit_note, success_confirmation, return_note, pickup_delivery, repair_bill, dunning_letter, offer, order_confirmation, credit_note, correction_document, delivery_note, invoice, invoice_external, receipt
page Int The page to get. The default page that will be returned is page 1.
itemsPerPage Int The number of orders to be displayed per page. The default number of orders per page is 50.
with String[] Load additional relations for an order. Currently possible are:
  • 'addresses' = The address objects that are associated with the order.
  • 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.
  • 'comments' = The order comments.
  • 'location' = The accounting location of the order.
  • 'payments' = The payments that are associated with the order.
  • 'documents' = The documents that are associated with the order.
  • 'orderItems.variation' = The variation that is associated with the order item.
  • 'orderItems.giftCardCodes' = The gift card codes that are associated with the order item.
  • 'orderItems.transactions' = The transactions that are associated with the order item.
  • 'orderItems.serialNumbers' = The serial numbers that are associated with the order item.
  • 'orderItems.variationBarcodes' = The barcodes that are associated with variation of the order item.
Example: ?with[]=addresses&with[]=orderItems.variation

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries Order[] List of Order
 id Int The ID of the order
 typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
 statusId Float The ID of the order status
 statusName String The name for the status ID (read only)
 ownerId Int The user ID of the order's owner
 createdAt String|\Carbon The date that the order was created
 updatedAt String|\Carbon The date that the order was updated last
 plentyId Int The plenty ID of the client that the order belongs to
 locationId Int The ID of the location that the order belongs to
 lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get an order

Gets an order. The ID of the order must be specified.

/rest/orders/{orderId}

Parameters

Field Type Description
orderId Int The ID of the order.
with String[] Load additional relations for an order. Currently possible are: *
  • 'addresses' = The address objects that are associated with the order.
  • 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.
  • 'comments' = The order comments.
  • 'location' = The accounting location of the order.
  • 'payments' = The payments that are associated with the order.
  • 'documents' = The documents that are associated with the order.
  • 'orderItems.variation' = The variation that is associated with the order item.
  • 'orderItems.giftCardCodes' = The gift card codes that are associated with the order item.
  • 'orderItems.transactions' = The transactions that are associated with the order item.
  • 'orderItems.serialNumbers' = The serial numbers that are associated with the order item.
  • 'orderItems.variationBarcodes' = The barcodes that are associated with variation of the order item.
Example: ?with[]=addresses&with[]=orderItems.variation

Success 200

Field Type Description
id Int The ID of the order
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
statusId Float The ID of the order status
statusName String The name for the status ID (read only)
ownerId Int The user ID of the order's owner
createdAt String|\Carbon The date that the order was created
updatedAt String|\Carbon The date that the order was updated last
plentyId Int The plenty ID of the client that the order belongs to
locationId Int The ID of the location that the order belongs to
lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked
{"properties":[{"orderId":104,"typeId":13,"value":"14"},{"orderId":104,"typeId":2,"value":"6"},{"orderId":104,"typeId":1,"value":"1"},{"orderId":104,"typeId":17,"value":"de"}],"addressRelations":[{"orderId":104,"typeId":1,"addressId":18},{"orderId":104,"typeId":2,"addressId":18}],"addresses":[],"relations":[{"orderId":104,"referenceType":"warehouse","referenceId":1,"relation":"sender"},{"orderId":104,"referenceType":"contact","referenceId":118,"relation":"receiver"}],"dates":[],"id":104,"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","orderItems":[{"id":105,"orderId":104,"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"orderItemName":"Awesome shoes","attributeValues":"Black","shippingProfileId":1,"vatField":1,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":105,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":300,"priceOriginalNet":252.10084033613,"surcharge":20,"discount":10,"isPercentage":true,"priceGross":288,"priceNet":242.01680672269}],"properties":[{"orderItemId":105,"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]},{"id":0,"orderId":104,"typeId":6,"referrerId":0,"itemVariationId":0,"quantity":1,"orderItemName":"Shipping Costs","attributeValues":"","shippingProfileId":6,"vatField":0,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":0,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":12.9,"priceOriginalNet":10.840336134454,"priceGross":12.9,"priceNet":10.840336134454}],"properties":[]}],"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"isNet":true,"netTotal":252.86,"grossTotal":300.9,"vatTotal":0,"invoiceTotal":252.86,"paidAmount":0,"vats":[{"vatField":0,"vatAmount":19,"value":48.042857142857}]}]}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List orders of a contact

Lists all orders of a contact. The ID of the contact must be specified.

/rest/orders/contacts/{contactId}

Parameters

Field Type Description
contactId Int The id of the contact to search the orders
page Int The page to get. The default page that will be returned is page 1.
itemsPerPage Int The number of orders to be displayed per page. The default number of orders per page is 50.
with String[] Load additional relations for an order. Currently possible are:
  • 'addresses' = The address objects that are associated with the order.
  • 'relations' = The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.
  • 'comments' = The order comments.
  • 'location' = The accounting location of the order.
  • 'payments' = The payments that are associated with the order.
  • 'documents' = The documents that are associated with the order.
  • 'orderItems.variation' = The variation that is associated with the order item.
  • 'orderItems.giftCardCodes' = The gift card codes that are associated with the order item.
  • 'orderItems.transactions' = The transactions that are associated with the order item.
  • 'orderItems.serialNumbers' = The serial numbers that are associated with the order item.
  • 'orderItems.variationBarcodes' = The barcodes that are associated with variation of the order item.
Example: ?with[]=addresses&with[]=orderItems.variation

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries Order[] List of Order
 id Int The ID of the order
 typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
 statusId Float The ID of the order status
 statusName String The name for the status ID (read only)
 ownerId Int The user ID of the order's owner
 createdAt String|\Carbon The date that the order was created
 updatedAt String|\Carbon The date that the order was updated last
 plentyId Int The plenty ID of the client that the order belongs to
 locationId Int The ID of the location that the order belongs to
 lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked
{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"properties":[{"orderId":104,"typeId":13,"value":"14"},{"orderId":104,"typeId":2,"value":"6"},{"orderId":104,"typeId":1,"value":"1"},{"orderId":104,"typeId":17,"value":"de"}],"addressRelations":[{"orderId":104,"typeId":1,"addressId":18},{"orderId":104,"typeId":2,"addressId":18}],"addresses":[],"relations":[{"orderId":104,"referenceType":"warehouse","referenceId":1,"relation":"sender"},{"orderId":104,"referenceType":"contact","referenceId":118,"relation":"receiver"}],"dates":[],"id":104,"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","orderItems":[{"id":105,"orderId":104,"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"orderItemName":"Awesome shoes","attributeValues":"Black","shippingProfileId":1,"vatField":1,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":105,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":300,"priceOriginalNet":252.10084033613,"surcharge":20,"discount":10,"isPercentage":true,"priceGross":288,"priceNet":242.01680672269}],"properties":[{"orderItemId":105,"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]},{"id":0,"orderId":104,"typeId":6,"referrerId":0,"itemVariationId":0,"quantity":1,"orderItemName":"Shipping Costs","attributeValues":"","shippingProfileId":6,"vatField":0,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":0,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":12.9,"priceOriginalNet":10.840336134454,"priceGross":12.9,"priceNet":10.840336134454}],"properties":[]}],"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"isNet":true,"netTotal":252.86,"grossTotal":300.9,"vatTotal":0,"invoiceTotal":252.86,"paidAmount":0,"vats":[{"vatField":0,"vatAmount":19,"value":48.042857142857}]}]},{"properties":[{"orderId":104,"typeId":13,"value":"14"},{"orderId":104,"typeId":2,"value":"6"},{"orderId":104,"typeId":1,"value":"1"},{"orderId":104,"typeId":17,"value":"de"}],"addressRelations":[{"orderId":104,"typeId":1,"addressId":18},{"orderId":104,"typeId":2,"addressId":18}],"addresses":[],"relations":[{"orderId":104,"referenceType":"warehouse","referenceId":1,"relation":"sender"},{"orderId":104,"referenceType":"contact","referenceId":118,"relation":"receiver"}],"dates":[],"id":104,"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","orderItems":[{"id":105,"orderId":104,"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"orderItemName":"Awesome shoes","attributeValues":"Black","shippingProfileId":1,"vatField":1,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":105,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":300,"priceOriginalNet":252.10084033613,"surcharge":20,"discount":10,"isPercentage":true,"priceGross":288,"priceNet":242.01680672269}],"properties":[{"orderItemId":105,"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]},{"id":0,"orderId":104,"typeId":6,"referrerId":0,"itemVariationId":0,"quantity":1,"orderItemName":"Shipping Costs","attributeValues":"","shippingProfileId":6,"vatField":0,"vatRate":19,"createdAt":"2016-10-24T13:33:23+02:00","updatedAt":"2016-10-24T13:33:23+02:00","amounts":[{"orderItemId":0,"currency":"EUR","exchangeRate":1,"isSystemCurrency":true,"priceOriginalGross":12.9,"priceOriginalNet":10.840336134454,"priceGross":12.9,"priceNet":10.840336134454}],"properties":[]}],"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"isNet":true,"netTotal":252.86,"grossTotal":300.9,"vatTotal":0,"invoiceTotal":252.86,"paidAmount":0,"vats":[{"vatField":0,"vatAmount":19,"value":48.042857142857}]}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update an order

Updates an order. The ID of the order must be specified.

/rest/orders/{orderId}

Parameters

Field Type Description
orderId Int The ID of the order

Request

Field Type Description
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
optional
plentyId Int The plenty ID of the client that the order belongs to optional
statusId Float The ID of the order status optional
ownerId Int The user ID of the order's owner optional
orderItems \OrderItem[]|\Collection The order items that are associated with the order. optional array
properties \OrderProperty[]|\Collection The order properties that are associated with the order. optional array
addressRelations \AddressOrderRelation[]|\Collection The address relations for this order. optional array
relations \OrderRelationReference[]|\Collection The order relation reference instances that are associated with the order. optional array
{"typeId":1,"ownerId":3,"plentyId":1000,"locationId":1,"statusId":3,"orderItems":[{"typeId":1,"referrerId":1,"itemVariationId":1001,"quantity":1,"countryVatId":1,"vatField":0,"vatRate":19,"orderItemName":"Awesome shoes","shippingProfileId":1,"amounts":[{"isSystemCurrency":true,"currency":"EUR","exchangeRate":1,"priceOriginalGross":300,"surcharge":20,"discount":10,"isPercentage":true}],"properties":[{"typeId":1,"value":"1"}],"orderProperties":[{"propertyId":4,"value":"image.jpg","fileUrl":"http:\/\/www.example.com\/image.jpg"}]}],"properties":[{"typeId":13,"value":"14"}],"addressRelations":[{"typeId":1,"addressId":18},{"typeId":2,"addressId":18}],"relations":[{"referenceType":"contact","referenceId":118,"relation":"receiver"}]}

Success 200

Field Type Description
id Int The ID of the order
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
statusId Float The ID of the order status
statusName String The name for the status ID (read only)
ownerId Int The user ID of the order's owner
createdAt String|\Carbon The date that the order was created
updatedAt String|\Carbon The date that the order was updated last
plentyId Int The plenty ID of the client that the order belongs to
locationId Int The ID of the location that the order belongs to
lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List package numbers of an order

Lists the package numbers of an order. The ID of the order must be specified.

/rest/orders/{orderId}/packagenumbers

Parameters

Field Type Description
orderId Int The ID of the order

Success 200

["J92356732176","003478943219912"]

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete an order

Deletes an order. The ID of the order must be specified.

/rest/orders/{orderId}

Parameters

Field Type Description
orderId Int The ID of the order to be deleted.

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Cancel an order

Cancels an order. The ID of the order must be specified.

/rest/orders/{orderId}/cancel

Parameters

Field Type Description
orderId Int The ID of the order to be canceled.

Request

Field Type Description
statusId Float The ID of the order status optional
message String The message that is displayed in the status history optional
null

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a multi-order

Creates a multi-order for a contact. The ID of the contact must be specified. Options chosen in the System » Orders » Order types » Multi-order menu are relevant for this call.

/rest/orders/contacts/{contactId}/multi_order

Success 200

Field Type Description
id Int The ID of the order
typeId Int The ID of the order type It is possible to define individual order types. However, the following types are available by default:
  • Sales order = 1
  • Delivery = 2
  • Returns = 3
  • Credit note = 4
  • Warranty = 5
  • Repair = 6
  • Offer = 7
  • Advance order = 8
  • Multi-order = 9
  • Multi credit note = 10
  • Multi delivery = 11
  • Reorder = 12
  • Partial delivery = 13
  • Subscription = 14
  • Redistribution = 15
statusId Float The ID of the order status
statusName String The name for the status ID (read only)
ownerId Int The user ID of the order's owner
createdAt String|\Carbon The date that the order was created
updatedAt String|\Carbon The date that the order was updated last
plentyId Int The plenty ID of the client that the order belongs to
locationId Int The ID of the location that the order belongs to
lockStatus String The lock status of the order. The following statuses are available:
  • unlocked
  • permanentlyLocked
  • reversibleLocked

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get an order parcel service region

Gets an parcel service region. The ID of the parcel service region must be specified.

/rest/orders/shipping/parcel_service_regions/{parcelServiceRegionId}

Parameters

Field Type Description
$parcelServiceRegionId Int The ID of the parcel service region
columns String[] The properties to be loaded

Success 200

Field Type Description
id Int The ID of the parcel service region
shippingRegionId Int The ID of the shipping region
parcelServicePresetId Int The ID of the parcel service preset
shippingRegionName String The name of the shipping region
serviceType Int Type of the parcel service
{"id":1,"shippingRegionId":101,"parcelServicePresetId":6,"shippingRegionName":"Germany","serviceType":2}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Lists parcel service regions by parcel service preset id.

Lists parcel service regions. The ID of the parcel service preset must be specified.

/rest/orders/shipping/presets/{presetId}/parcel_service_regions

Parameters

Field Type Description
$parcelServicePresetId Int The ID of the parcel service preset
columns String[] The properties to be loaded

Success 200

Field Type Description
id Int The ID of the parcel service region
shippingRegionId Int The ID of the shipping region
parcelServicePresetId Int The ID of the parcel service preset
shippingRegionName String The name of the shipping region
serviceType Int Type of the parcel service
[{"shippingRegionId":{"id":78,"shippingRegionId":320,"parcelServicePresetId":6,"shippingRegionName":"Cayman Islands","serviceType":15}},{"shippingRegionId":{"id":52,"shippingRegionId":293,"parcelServicePresetId":6,"shippingRegionName":"Montserrat","serviceType":12}}]

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.