Get, create, update or delete the shipping information that is saved in the shipping centre.
Gets the shipping information. The ID of the order must be specified.
/rest/orders/{orderId}/shipping/shipping_information
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
shippingServiceProvider | String |
The name of the shipping service provider |
transactionId | String |
The ID of the transaction |
shippingStatus | String |
The shipping status. Possible values are 'open', 'prepared' and 'registered'. |
shippingCosts | Float |
The shipping costs |
additionalData | String |
The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID. |
registrationAt | Int |
The date and time the shipment was registered |
shipmentAt | Int |
The date the items will be shipped |
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 the shipping information. The ID of the order must be specified.
/rest/orders/{orderId}/shipping/shipping_information
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
shippingServiceProvider | String |
The name of the shipping service provider |
transactionId | String |
The ID of the transaction |
shippingStatus | String |
The shipping status. Possible values are 'open', 'prepared' and 'registered'. |
shippingCosts | Float |
The shipping costs |
additionalData | String |
The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID. |
registrationAt | Int |
The date and time the shipment was registered |
shipmentAt | Int |
The date the items will be shipped |
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/shipping/shipping_information
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
shippingServiceProvider | String |
The name of the shipping service provider |
transactionId | String |
The ID of the transaction |
shippingStatus | String |
The shipping status. Possible values are 'open', 'prepared' and 'registered'. |
shippingCosts | Float |
The shipping costs |
additionalData | String |
The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID. |
registrationAt | Int |
The date and time the shipment was registered |
shipmentAt | Int |
The date the items will be shipped |
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 the shipping status of the shipping information. The ID of the order must be specified.
/rest/orders/{orderId}/shipping/shipping_information/status
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
shippingServiceProvider | String |
The name of the shipping service provider |
transactionId | String |
The ID of the transaction |
shippingStatus | String |
The shipping status. Possible values are 'open', 'prepared' and 'registered'. |
shippingCosts | Float |
The shipping costs |
additionalData | String |
The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID. |
registrationAt | Int |
The date and time the shipment was registered |
shipmentAt | Int |
The date the items will be shipped |
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 additional data of the shipping information. The ID of the order must be specified.
/rest/orders/{orderId}/shipping/shipping_information/additional_data
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order |
shippingServiceProvider | String |
The name of the shipping service provider |
transactionId | String |
The ID of the transaction |
shippingStatus | String |
The shipping status. Possible values are 'open', 'prepared' and 'registered'. |
shippingCosts | Float |
The shipping costs |
additionalData | String |
The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID. |
registrationAt | Int |
The date and time the shipment was registered |
shipmentAt | Int |
The date the items will be shipped |
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. |