The linked person's orders

Query parameters

• page integer
  at least 1 default 1

Response

200 Orders, newest first

• data array of Order
  5 child attributes

  • order_number string
  • placed_at string date-time
  • status string
    One of paid partly_shipped shipped delivered cancelled refunded
  • total Money
    2 child attributes

    • amount string Required

      Decimal string, two places

    • currency string Required
      One of CAD
  • shipments array of Shipment
    6 child attributes

    • store StoreSummary
      4 child attributes

      • slug string Required

        The store's address label; use it in the store filter and GET /stores/{store_slug}

      • name string Required
      • url string uri Required
      • agent_checkout string Required

        How an assistant completes a purchase here. link — create a checkout and give the person its link; they review and pay on the store. direct — the store also accepts purchases an assistant makes for a person who allowed it, within the limits they set. Every store is link unless its owner opted in.

        One of direct link
    • status string
      One of preparing shipped delivered cancelled refunded
    • carrier string Can be null
    • tracking_number string Can be null
    • tracking_url string uri Can be null
    • delivered_at string date-time Can be null
• pagination Pagination
  4 child attributes

  • page integer
  • per_page integer
  • total integer
  • last_page integer

Status codes

Errors share one shape — see Errors and rate limits.