1. Home
  2. Knowledge Base
  3. REST API
  4. Purchase Order Services
  5. Update PO Shipping Information (Single Tracking)

Update PO Shipping Information (Single Tracking)

Overview

This endpoint can be used to update the tracking on a single existing Purchase Order. Note that it will only work if the Client Setting Enable Multiple Tracking Numbers On PO is disabled.

To consume the endpoint, you must:

  • Be an authenticated user.

For information on how you can authenticate, see Authentication.

After you authenticate and receive a valid token, you must pass it to service calls.

Endpoint

An example of this endpoint for XX server is:

  • https://XX.api.sellercloud.com/rest/api/PurchaseOrders/{id}/TrackingNumber

For your server, the endpoint will be:

  • https://{your_server_id}.api.sellercloud.com/rest/api/PurchaseOrders/{id}/TrackingNumber

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json

Request Body

ParameterParameter TypeData TypeDescriptionRequired
idpathIntegerID of the targeted Purchase Order.yes
ShippedOnbodyDateTimeDate and time when the PO was shipped. You can only update this value if the PO Shipping status is not “None”.

Set to null or omit in the request if update of this field is not needed.

no
ShippedViaCarrierbodyStringShipping Carrier Name.

Set to null or omit in the request if update of this field is not needed.

no
TrackingNumberbodyStringTracking Number.

Set to null or omit in the request if update of this field is not needed.

no

The request body should be formatted as follows:

Response

  • If the user is authenticated and the request is successful, the response is Status Code 200 => OK
  • If the user is not authenticated, the response is Status Code 401 => Invalid Token
  • In case of an error, the response is Status Code 500 => Internal Server Error
  • In case of an incorrect request, the response is Status Code 400 => Bad Request

Was this article helpful?

Next
Update PO Invoice Number