Update Order Shipping Information

Overview

This endpoint is used for updating the shipping information of an order.

The endpoint does not update tracking or package information.

In order to use this endpoint, you must:

  • Be authenticated

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call when updating the order.

  • Have a valid ID of an existing order

Endpoint

An example of such an endpoint for XX server is:

https://xx.api.sellercloud.com/rest/api/Orders/{orderID}/Shipping/Details

For your server endpoint will be:

https://{your_server_id}.sellercloud.com/rest/api/Orders/{orderID}/Shipping/Details

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters: orderID of the unshipped sales order
  • Body data:
    ParameterData TypeDescriptionIs Required
    CustomerShippingFeedecimalCustomer Shipping Fee

    Do not provide or set to null in the request if update of this field is not needed.

    No
    CustomerShippingDiscountdecimalCustomer Shipping Discount

    Do not provide or set to null in the request if update of this field is not needed. dollar amount.

    No
    CustomerHandlingFeedecimalCustomer Handling Fee

    Do not provide or set to null in the request if update of this field is not needed. dollar amount.

    No
    CarrierstringCarrier key

    When provided for update, the Service has to be provided as well.

    Do not provide or set to null in the request if update of this field is not needed.

    No
    ServicestringShipping service of the carrier

    When provided for update, the Carrier has to be provided as well.

    Do not provide or set to null in the request if update of this field is not needed.

    No
    OtherServicestringOther service name

    When the Service is set to “Other,” then the Other Service Name must be provided.

    Do not provide or set to null in the request if update of this field is not needed.

    No
    AllowShippingEvenNotPaidbooleanControls whether the order can be shipped before payment is captured.

    Do not provide or set to null in the request if update of this field is not needed.

    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?

Next
Update Purchase Order