REST Order ShippingInformation

Get, create, update or delete the shipping information that is saved in the shipping centre.

Get shipping information

Gets the shipping information. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/shipping_information

Success 200

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
{"orderId":107,"shippingServiceProvider":"Dpd Cloud Webservice","transactionId":"","shippingStatus":"registered","shippingCosts":"0.00","additionalData":{"ShipService":"Classic","Reference1":"john@account.com","Reference2":"Order: 107"},"registrationAt":"2016-12-23T11:11:00+01:00","shipmentAt":"2016-12-23T00:00:00+01:00"}

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 shipping information

Deletes the shipping information. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/shipping_information

Success 200

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

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 shipping information

/rest/orders/shipping/shipping_information

Success 200

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
{"orderId":107,"shippingServiceProvider":"Dpd Cloud Webservice","transactionId":"","shippingStatus":"registered","shippingCosts":"0.00","additionalData":{"ShipService":"Classic","Reference1":"john@account.com","Reference2":"Order: 107"},"registrationAt":"2016-12-23T11:11:00+01:00","shipmentAt":"2016-12-23T00:00:00+01:00"}

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 the shipping status of the shipping information

Updates the shipping status of the shipping information. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/shipping_information/status

Success 200

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
{"orderId":107,"shippingServiceProvider":"Dpd Cloud Webservice","transactionId":"","shippingStatus":"registered","shippingCosts":"0.00","additionalData":{"ShipService":"Classic","Reference1":"john@account.com","Reference2":"Order: 107"},"registrationAt":"2016-12-23T11:11:00+01:00","shipmentAt":"2016-12-23T00:00:00+01:00"}

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 additional data of the shipping information

Updates additional data of the shipping information. The ID of the order must be specified.

/rest/orders/{orderId}/shipping/shipping_information/additional_data

Success 200

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
{"orderId":107,"shippingServiceProvider":"Dpd Cloud Webservice","transactionId":"","shippingStatus":"registered","shippingCosts":"0.00","additionalData":{"ShipService":"Classic","Reference1":"john@account.com","Reference2":"Order: 107"},"registrationAt":"2016-12-23T11:11:00+01:00","shipmentAt":"2016-12-23T00:00:00+01:00"}

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.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!