List parcel service region by preset ID or get by parcel service region ID.
/rest/orders
Field | Type | Description |
---|---|---|
coupon | String[] |
One or multiple coupon code to be redeemed with order creation |
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:
|
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:
|
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 |
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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. |
/rest/orders
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. |
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. |
orderItemName | String |
Filter that restricts the search results to orders with a certain item name. The name of the item must be specified. |
variationNumber | Int |
Filter that restricts the search results to orders with a specific variation number. The number of the variation must be specified. |
sender.contact | Int |
Filter that restricts the search results to orders with a specific sender of the type contact. The id of the sender must be specified. |
sender.warehouse | Int |
Filter that restricts the search results to orders with a specific sender of the type warehouse. The id of the sender must be specified. |
receiver.contact | Int |
Filter that restricts the search results to orders with a specific receiver of the type contact. The id of the receiver must be specified. |
receiver.warehouse | Int |
Filter that restricts the search results to orders with a specific receiver of the type warehouse. The id of the receiver must be specified. |
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 |
hasDocumentNumber | String |
Filter that restricts the search result to orders which hold documents with given number. |
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:
?with[]=addresses&with[]=orderItems.variation |
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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. |
Gets an order. The ID of the order must be specified.
/rest/orders/{orderId}
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order. |
with | String[] |
Load additional relations for an order. Currently possible are:
*
?with[]=addresses&with[]=orderItems.variation |
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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 all orders of a contact. The ID of the contact must be specified.
/rest/orders/contacts/{contactId}
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:
?with[]=addresses&with[]=orderItems.variation |
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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. |
Updates an order. The ID of the order must be specified.
/rest/orders/{orderId}
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
Field | Type | Description |
---|---|---|
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 |
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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 the package numbers of an order. The ID of the order must be specified.
/rest/orders/{orderId}/packagenumbers
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
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. |
Deletes an order. The ID of the order must be specified.
/rest/orders/{orderId}
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order to be deleted. |
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. |
Cancels an order. The ID of the order must be specified.
/rest/orders/{orderId}/cancel
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order to be canceled. |
Field | Type | Description |
---|---|---|
statusId | Float |
The ID of the order status optional |
message | String |
The message that is displayed in the status history optional |
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. |
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
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:
|
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 |
referrerId | Float |
The referrer ID of the order |
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:
|
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. |
Gets an parcel service region. The ID of the parcel service region must be specified.
/rest/orders/shipping/parcel_service_regions/{parcelServiceRegionId}
Field | Type | Description |
---|---|---|
$parcelServiceRegionId | Int |
The ID of the parcel service region |
columns | String[] |
The properties to be loaded |
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 |
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. The ID of the parcel service preset must be specified.
/rest/orders/shipping/presets/{presetId}/parcel_service_regions
Field | Type | Description |
---|---|---|
$parcelServicePresetId | Int |
The ID of the parcel service preset |
columns | String[] |
The properties to be loaded |
List
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 |
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. |