Objects

The Order object

Fields of the Order object.

Attributes

• id string required
• order_number string nullable
• status string required

  One of unpaid pending paid completed charged_back cancelled

• first_name string
• last_name string
• email string
• organization_name string nullable
• phone string nullable
• address string nullable
• postal_code string nullable
• city string nullable
• country string nullable

  ISO 3166-1 alpha-2 country code

• vat_number string nullable
• carrier string nullable
• tracktrace string nullable
• wc_order_id integer nullable
• wc_order_number string nullable
• subscription string nullable
• subscription_status string nullable

  One of active cancelled completed

• cancel_subscription_at string nullable
• total_amount string required
• currency string required

  One of AED AUD BGN BRL CAD CHF CZK DKK EUR GBP HKD HUF ILS ISK JPY MXN MYR NOK NZD PHP PLN RON SEK SGD THB TWD USD ZAR

• created_at string required
• products array of OrderProducts
  3 child attributes · OrderProduct

  • next_order string nullable
  • quantity integer required
  • product object required
    8 child attributes

    • id string
    • name string
    • type string

      One of once subscription shipping_costs

    • amount string
    • currency string

      One of AED AUD BGN BRL CAD CHF CZK DKK EUR GBP HKD HUF ILS ISK JPY MXN MYR NOK NZD PHP PLN RON SEK SGD THB TWD USD ZAR

    • interval string nullable

      One of day week month year

    • times integer nullable
    • wc_product_id integer nullable