OrderFulfillment

Tracking details, present once tracking has been added during fulfillment (STABLE).

Type: object

Example

Schema example: from the PATCH /orders/{orderId}/fulfillment response

{
  "tracking_company": "Canada Post",
  "tracking_number": "CX123456789CA",
  "tracking_url": "https://www.canadapost-postescanada.ca/track-reperage/en#/details/CX123456789CA"
}

Fields

tracking_company string required

Carrier/company name, as the fulfiller entered it (STABLE).

Example Canada Post

tracking_number string required

Carrier tracking number (STABLE).

Example CX123456789CA

tracking_url string or null required

Tracking link; null if the fulfiller supplied none (STABLE).

Example https://www.canadapost-postescanada.ca/track-reperage/en#/details/CX123456789CA

Used by

GET /orders - Poll orders (response)
GET /orders/{orderId} - Get one order (response)
PATCH /orders/{orderId}/fulfillment - Update fulfillment (response)
POST /orders/{orderId}/cancel - Cancel an order (response)
POST /orders/{orderId}/refunds - Create a refund (response)
POST /orders/{orderId}/corrections - Correct the ship-to address (response)
POST /orders/{orderId}/address-verification/retry - Retry address verification (response)
order.created - Order created (payload)
order.updated - Order updated (payload)