Update Order Shipping Packages

Overview

This endpoint can be used to update the details of existing packages in a single sales order. Note that you cannot change the contents of the package with this endpoint. To do that, you would need to use the Create Shipping Packages endpoint, which allows you to delete and recreate them.

In order to update existing shipping packages of an order, you must:

  • Be an authenticated user.

Information on how you can authenticate: Authentication

As soon as you do the authentication and receive a valid token, you need to pass it on to each call when updating inventory.

  • Have valid IDs of existing an order and its packages.

Endpoint

An example of such an endpoint on XX server is https://xx.api.sellercloud.com/rest/api/Orders/{orderID}/Shipping/Packages

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Path parameter: Order ID
  • Body data:
ParameterData TypeDescriptionIs Required
PackagesobjectShipping Packages.Yes
IDstringID of an existing package within that order.Yes
LengthintThe package length.No
WidthintThe package width.No
HeightintThe package height.No
WeightintThe package shipping weight.No
DeclaredValueintThe declared value for the contents of the package.No

Request Format

Response

  • If the user is authenticated and the request is successful, then the response will be Status Code 200 => OK
  • If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token
  • In case of an error, the response will be Status Code 500 => Internal Server Error
  • In case of an incorrect request, the response will be with status code 400 Bad Request

Was this article helpful?