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
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
On this page
  • Attributes
  • Example Shipping Courier object
  • Australia
  • New Zealand
  • United States of America
Models

Shipping Courier object

Was this page helpful?
Previous

Ping

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

Australia

1{
2 "shippedAt": "2019-01-01T00:00:00+10:00",
3 "name": "Australia Post",
4 "tracking": "AA0000000000000",
5 "priority": "STANDARD"
6}

New Zealand

1{
2 "shippedAt": "2019-01-01T00:00:00+13:00",
3 "name": "CourierPost",
4 "tracking": "AA999999999AA",
5 "priority": "STANDARD"
6}

United States of America

1{
2 "shippedAt": "2019-01-01T00:00:00-08:00",
3 "name": "FedEx",
4 "tracking": "000 000 000 000",
5 "priority": "STANDARD"
6}