For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Request Headers
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
      • Contact object
      • Consumer object
      • Discount object
      • Item object
      • Money object
      • Order Details object
      • Payment object
      • Refund object
      • Shipping Courier object
    • API Simulator
    • JavaScript afterpay.js
    • Errors
LogoLogo
On this page
  • Attributes
  • Example Shipping Courier object
Online APIModels

Shipping Courier object

Was this page helpful?
Previous

API Simulator

Next
Built with

Attributes

AttributeTypeDescription
shippedAtstringThe date and time when the order was shipped, in ISO 8601 format.
namestringThe name of the courier. Limited to 128 characters.
trackingstringThe tracking number provided by the courier. Limited to 128 characters.
prioritystringThe shipping priority. If provided, must be either “STANDARD” or “EXPRESS”.

Example Shipping Courier object

UK
1{
2  "shippedAt": "2019-01-01T00:00:00+10:00",
3  "name": "Parcelforce Worldwide",
4  "tracking": "AAAA1234567890",
5  "priority": "STANDARD"
6}