Shipments

Add a tracking code to order items

Ship order items under a tracking code from the seller's own label. The items move onto one shipment with the tracking code, usually a new one, so read each item's shipment afterwards. The items must ship to the same buyer and address, their shipments must not have been dropped off or shipped, and the seller must be able to use their own labels. Requires write:shipments.

post/shipments/add_tracking_code

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/shipments/add_tracking_code
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Request body

order_item_idsstring[] required

The decimal IDs of the order items to ship under the tracking code.

tracking_codestring required

The carrier's tracking code for the package.

carrierstring required

The carrier delivering the package.

Example request

{
  "carrier": "usps"
}

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.