Order

{
  "id": "Required, unique order identifier, numeric type",
  "admin_graphql_api_id": "Optional, unique order identifier in GraphQL API",
  "app_id": "Optional, application ID that created the order, numeric type",
  "browser_ip": "Required, customer's IP address at checkout",
  "buyer_accepts_marketing": "Optional, whether customer accepts marketing emails, boolean type",
  "cancel_reason": "Optional, order cancellation reason, null if none",
  "cancelled_at": "Optional, order cancellation time, null if none",
  "cart_token": "Optional, unique cart identifier",
  "checkout_id": "Optional, unique checkout identifier, numeric type",
  "checkout_token": "Optional, checkout token",
  "client_details": {
    "accept_language": "Required, customer's browser language setting",
    "browser_height": "Optional, browser window height, null if none",
    "browser_ip": "Required, customer's browser IP address",
    "browser_width": "Optional, browser window width, null if none",
    "session_hash": "Optional, session hash value, null if none",
    "user_agent": "Required, customer's browser User-Agent information"
  },
  "closed_at": "Optional, order closing time, null if none",
  "company": "Optional, associated company information, null if none",
  "confirmation_number": "Optional, order confirmation number",
  "confirmed": "Optional, whether order is confirmed, boolean type",
  "contact_email": "Required, customer's contact email",
  "created_at": "Required, order creation time, ISO 8601 format",
  "currency": "Required, order currency code",
  "current_subtotal_price": "Required, current order subtotal amount, string type",
  "current_subtotal_price_set": {
    "shop_money": {
      "amount": "Required, shop currency amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "current_total_additional_fees_set": "Optional, current order additional fees, null if none",
  "current_total_discounts": "Required, current order total discount amount, string type",
  "current_total_discounts_set": {
    "shop_money": {
      "amount": "Required, shop currency discount amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency discount amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "current_total_duties_set": {
    "shop_money": {
      "amount": "Required, shop currency duties amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency duties amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "current_total_price": "Required, current order total amount, string type",
  "current_total_price_set": {
    "shop_money": {
      "amount": "Required, shop currency total amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency total amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "current_total_tax": "Required, current order total tax amount, string type",
  "current_total_tax_set": {
    "shop_money": {
      "amount": "Required, shop currency tax amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency tax amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "customer_locale": "Optional, customer's locale setting",
  "device_id": "Optional, device ID, null if none",
  "discount_codes": "Required, discount codes list, empty array if none",
  "duties_included": "Required, whether duties are included, boolean type",
  "email": "Required, customer's email address",
  "estimated_taxes": "Required, whether taxes are estimated, boolean type",
  "financial_status": "Required, order financial status (e.g., pending, authorized, partially_paid, paid, refunded, voided, partially_refunded)",
  "fulfillment_status": "Optional, order fulfillment status, null if none (fulfilled, null, partial, restocked)",
  "landing_site": "Required, customer's landing site URL",
  "landing_site_ref": "Optional, landing site reference identifier, null if none",
  "location_id": "Optional, associated location ID, null if none",
  "merchant_business_entity_id": "Optional, merchant business entity ID",
  "merchant_of_record_app_id": "Optional, merchant of record app ID, null if none",
  "name": "Required, order name",
  "note": "Optional, order notes, null if none",
  "note_attributes": "Required, order note attributes list, empty array if none",
  "number": "Required, order number, numeric type",
  "order_number": "Required, order display number, numeric type",
  "order_status_url": "Required, order status page URL",
  "original_total_additional_fees_set": "Optional, original order additional fees, null if none",
  "original_total_duties_set": {
    "shop_money": {
      "amount": "Required, shop currency original duties amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency original duties amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "payment_gateway_names": "Required, payment gateway names list, array",
  "phone": "Optional, customer phone number, null if none",
  "po_number": "Optional, purchase order number, null if none",
  "presentment_currency": "Required, presentment currency code",
  "processed_at": "Required, order processing time, ISO 8601 format",
  "reference": "Required, order reference identifier",
  "referring_site": "Required, order referring site URL, empty string if none",
  "source_identifier": "Optional, order source identifier",
  "source_name": "Required, order source name (e.g., web)",
  "source_url": "Optional, order source URL, null if none",
  "subtotal_price": "Required, order subtotal amount, string type",
  "subtotal_price_set": {
    "shop_money": {
      "amount": "Required, shop currency subtotal amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency subtotal amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "tags": "Required, order tags, empty string if none",
  "tax_exempt": "Required, whether order is tax exempt, boolean type",
  "tax_lines": "Required, tax lines list, empty array if none",
  "taxes_included": "Required, whether taxes are included, boolean type",
  "test": "Required, whether test order, boolean type",
  "token": "Required, unique order token",
  "total_cash_rounding_payment_adjustment_set": {
    "shop_money": {
      "amount": "Required, shop currency cash rounding payment adjustment amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency cash rounding payment adjustment amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_cash_rounding_refund_adjustment_set": {
    "shop_money": {
      "amount": "Required, shop currency cash rounding refund adjustment amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency cash rounding refund adjustment amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_discounts": "Required, order total discounts amount, string type",
  "total_discounts_set": {
    "shop_money": {
      "amount": "Required, shop currency total discounts amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency total discounts amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_line_items_price": "Required, order line items total amount, string type",
  "total_line_items_price_set": {
    "shop_money": {
      "amount": "Required, shop currency line items total amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency line items total amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_outstanding": "Required, order outstanding amount, string type",
  "total_price": "Required, order total amount, string type",
  "total_price_set": {
    "shop_money": {
      "amount": "Required, shop currency total amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency total amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_shipping_price_set": {
    "shop_money": {
      "amount": "Required, shop currency shipping amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency shipping amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_tax": "Required, order total tax amount, string type",
  "total_tax_set": {
    "shop_money": {
      "amount": "Required, shop currency total tax amount, string type",
      "currency_code": "Required, shop currency code"
    },
    "presentment_money": {
      "amount": "Required, presentment currency total tax amount, string type",
      "currency_code": "Required, presentment currency code"
    }
  },
  "total_tip_received": "Optional, order tip amount received, string type",
  "total_weight": "Optional, order total weight, numeric type",
  "updated_at": "Required, order update time, ISO 8601 format",
  "user_id": "Optional, associated user ID, null if none",
  "billing_address": {
    "first_name": "Required, billing address first name",
    "address1": "Required, billing address line 1",
    "phone": "Optional, billing address phone number, null if none",
    "city": "Required, billing address city",
    "zip": "Required, billing address postal code",
    "province": "Required, billing address province",
    "country": "Required, billing address country",
    "last_name": "Required, billing address last name",
    "address2": "Optional, billing address line 2, null if none",
    "company": "Optional, billing address company name, null if none",
    "latitude": "Optional, billing address latitude, null if none",
    "longitude": "Optional, billing address longitude, null if none",
    "name": "Required, billing address full name",
    "country_code": "Required, billing address country code",
    "province_code": "Required, billing address province code"
  },
  "customer": {
    "id": "Required, unique customer identifier, numeric type",
    "email": "Required, customer email address",
    "created_at": "Required, customer creation time, ISO 8601 format",
    "updated_at": "Required, customer update time, ISO 8601 format",
    "first_name": "Required, customer first name",
    "last_name": "Required, customer last name",
    "state": "Required, customer status (e.g., disabled)",
    "note": "Optional, customer notes, null if none",
    "verified_email": "Required, whether email is verified, boolean type",
    "multipass_identifier": "Optional, Multipass identifier, null if none",
    "tax_exempt": "Optional, whether customer is tax exempt, boolean type",
    "phone": "Optional, customer phone number, null if none",
    "email_marketing_consent": {
      "state": "Optional, email marketing subscription status (e.g., not_subscribed)",
      "opt_in_level": "Optional, subscription level (e.g., single_opt_in)",
      "consent_updated_at": "Optional, subscription update time, null if none"
    },
    "sms_marketing_consent": "Optional, SMS marketing subscription information, null if none",
    "tags": "Required, customer tags, empty string if none",
    "currency": "Required, customer currency code",
    "tax_exemptions": "Optional, customer tax exemptions list, empty array if none",
    "admin_graphql_api_id": "Optional, unique customer identifier in GraphQL API",
    "default_address": {
      "id": "Required, default address unique identifier, numeric type",
      "customer_id": "Required, associated customer ID, numeric type",
      "first_name": "Required, default address first name",
      "last_name": "Required, default address last name",
      "company": "Optional, default address company name, null if none",
      "address1": "Required, default address line 1",
      "address2": "Optional, default address line 2, null if none",
      "city": "Required, default address city",
      "province": "Required, default address province",
      "country": "Required, default address country",
      "zip": "Required, default address postal code",
      "phone": "Optional, default address phone number, null if none",
      "name": "Required, default address full name",
      "province_code": "Required, default address province code",
      "country_code": "Required, default address country code",
      "country_name": "Required, default address country name",
      "default": "Required, whether default address, boolean type"
    }
  },
  "discount_applications": "Required, discount applications list, empty array if none",
  "fulfillments": "Required, order fulfillments list, empty array if none",
  "line_items": [
    {
      "id": "Required, line item unique identifier, numeric type",
      "admin_graphql_api_id": "Optional, line item unique identifier in GraphQL API",
      "current_quantity": "Required, current line item quantity, numeric type",
      "fulfillable_quantity": "Required, fulfillable quantity, numeric type",
      "fulfillment_service": "Optional, fulfillment service name",
      "fulfillment_status": "Optional, fulfillment status, null if none",
      "gift_card": "Optional, whether gift card, boolean type",
      "grams": "Optional, line item weight (grams), numeric type",
      "name": "Required, line item name",
      "price": "Required, line item unit price, string type",
      "price_set": {
        "shop_money": {
          "amount": "Required, shop currency unit price amount, string type",
          "currency_code": "Required, shop currency code"
        },
        "presentment_money": {
          "amount": "Required, presentment currency unit price amount, string type",
          "currency_code": "Required, presentment currency code"
        }
      },
      "product_exists": "Required, whether associated product exists, boolean type",
      "product_id": "Required, associated product ID, numeric type",
      "properties": "Optional, line item properties list, empty array if none",
      "quantity": "Required, line item quantity, numeric type",
      "requires_shipping": "Optional, whether requires shipping, boolean type",
      "sku": "Required, line item SKU, empty string if none",
      "taxable": "Required, whether taxable, boolean type",
      "title": "Required, line item title",
      "total_discount": "Required, line item total discount amount, string type",
      "total_discount_set": {
        "shop_money": {
          "amount": "Required, shop currency total discount amount, string type",
          "currency_code": "Required, shop currency code"
        },
        "presentment_money": {
          "amount": "Required, presentment currency total discount amount, string type",
          "currency_code": "Required, presentment currency code"
        }
      },
      "variant_id": "Required, associated product variant ID, numeric type",
      "variant_inventory_management": "Optional, variant inventory management method",
      "variant_title": "Optional, variant title, null if none",
      "vendor": "Optional, vendor name",
      "tax_lines": [
        {
          "channel_liable": "Required, whether channel is liable for tax, boolean type",
          "price": "Required, tax amount, string type",
          "price_set": {
            "shop_money": {
              "amount": "Required, shop currency tax amount, string type",
              "currency_code": "Required, shop currency code"
            },
            "presentment_money": {
              "amount": "Required, presentment currency tax amount, string type",
              "currency_code": "Required, presentment currency code"
            }
          },
          "rate": "Required, tax rate, numeric type",
          "title": "Required, tax title"
        }
      ],
      "duties": [
        {
          "id": "Required, duty unique identifier, numeric type",
          "admin_graphql_api_id": "Optional, duty unique identifier in GraphQL API",
          "country_code_of_origin": "Required, country of origin code",
          "harmonized_system_code": "Optional, harmonized system code, null if none",
          "price_set": {
            "shop_money": {
              "amount": "Required, shop currency duty amount, string type",
              "currency_code": "Required, shop currency code"
            },
            "presentment_money": {
              "amount": "Required, presentment currency duty amount, string type",
              "currency_code": "Required, presentment currency code"
            }
          },
          "tax_lines": "Required, duty tax lines list, empty array if none"
        }
      ],
      "discount_allocations": "Required, discount allocations list, empty array if none"
    }
  ],
  "payment_terms": "Optional, payment terms, null if none",
  "refunds": [
    {
      "id": "Required, refund unique identifier, numeric type",
      "admin_graphql_api_id": "Optional, refund unique identifier in GraphQL API",
      "created_at": "Required, refund creation time, ISO 8601 format",
      "note": "Required, refund notes, empty string if none",
      "order_id": "Required, associated order ID, numeric type",
      "processed_at": "Required, refund processing time, ISO 8601 format",
      "restock": "Required, whether restocked, boolean type",
      "total_duties_set": {
        "shop_money": {
          "amount": "Required, shop currency total duties amount, string type",
          "currency_code": "Required, shop currency code"
        },
        "presentment_money": {
          "amount": "Required, presentment currency total duties amount, string type",
          "currency_code": "Required, presentment currency code"
        }
      },
      "user_id": "Required, user ID processing refund, numeric type",
      "order_adjustments": "Required, order adjustments list, empty array if none",
      "transactions": [
        {
          "id": "Required, transaction unique identifier, numeric type",
          "admin_graphql_api_id": "Optional, transaction unique identifier in GraphQL API",
          "amount": "Required, transaction amount, string type",
          "authorization": "Optional, transaction authorization information, null if none",
          "created_at": "Required, transaction creation time, ISO 8601 format",
          "currency": "Required, transaction currency code",
          "device_id": "Optional, device ID, null if none",
          "error_code": "Optional, error code, null if none",
          "gateway": "Required, payment gateway name",
          "kind": "Required, transaction type (e.g., refund)",
          "location_id": "Optional, location ID, null if none",
          "message": "Required, transaction message",
          "order_id": "Required, associated order ID, numeric type",
          "parent_id": "Required, parent transaction ID, numeric type",
          "payment_id": "Required, payment ID",
          "processed_at": "Required, transaction processing time, ISO 8601 format",
          "receipt": {
            "paid_amount": "Required, paid amount, string type"
          },
          "source_name": "Required, transaction source name",
          "status": "Required, transaction status (e.g., success)",
          "test": "Required, whether test transaction, boolean type",
          "user_id": "Required, user ID processing transaction, numeric type",
          "payment_details": {
            "credit_card_bin": "Required, credit card BIN",
            "avs_result_code": "Optional, AVS result code, null if none",
            "cvv_result_code": "Optional, CVV result code, null if none",
            "credit_card_number": "Required, credit card number (partially masked)",
            "credit_card_company": "Required, credit card company name",
            "buyer_action_info": "Optional, buyer action information, null if none",
            "credit_card_name": "Required, credit card holder name",
            "credit_card_wallet": "Optional, credit card wallet information, null if none",
            "credit_card_expiration_month": "Required, credit card expiration month, numeric type",
            "credit_card_expiration_year": "Required, credit card expiration year, numeric type",
            "payment_method_name": "Required, payment method name"
          }
        }
      ],
      "refund_line_items": [
        {
          "id": "Required, refund line item unique identifier, numeric type",
          "line_item_id": "Required, associated line item ID, numeric type",
          "location_id": "Required, associated location ID, numeric type",
          "quantity": "Required, refund quantity, numeric type",
          "restock_type": "Required, restock type (e.g., cancel)",
          "subtotal": "Required, refund subtotal amount, numeric type",
          "subtotal_set": {
            "shop_money": {
              "amount": "Required, shop currency refund subtotal amount, string type",
              "currency_code": "Required, shop currency code"
            },
            "presentment_money": {
              "amount": "Required, presentment currency refund subtotal amount, string type",
              "currency_code": "Required, presentment currency code"
            }
          },
          "total_tax": "Required, refund total tax amount, numeric type",
          "total_tax_set": {
            "shop_money": {
              "amount": "Required, shop currency refund tax amount, string type",
              "currency_code": "Required, shop currency code"
            },
            "presentment_money": {
              "amount": "Required, presentment currency refund tax amount, string type",
              "currency_code": "Required, presentment currency code"
            }
          },
          "line_item": {
            "id": "Required, associated line item ID, numeric type",
            "admin_graphql_api_id": "Optional, line item unique identifier in GraphQL API",
            "current_quantity": "Required, current line item quantity, numeric type",
            "fulfillable_quantity": "Optional, fulfillable quantity, numeric type",
            "fulfillment_service": "Optional, fulfillment service name",
            "fulfillment_status": "Optional, fulfillment status, null if none",
            "gift_card": "Optional, whether gift card, boolean type",
            "grams": "Optional, line item weight (grams), numeric type",
            "name": "Required, line item name",
            "price": "Required, line item unit price, string type",
            "price_set": {
              "shop_money": {
                "amount": "Required, shop currency unit price amount, string type",
                "currency_code": "Required, shop currency code"
              },
              "presentment_money": {
                "amount": "Required, presentment currency unit price amount, string type",
                "currency_code": "Required, presentment currency code"
              }
            },
            "product_exists": "Required, whether associated product exists, boolean type",
            "product_id": "Required, associated product ID, numeric type",
            "properties": "Optional, line item properties list, empty array if none",
            "quantity": "Required, line item quantity, numeric type",
            "requires_shipping": "Optional, whether requires shipping, boolean type",
            "sku": "Required, line item SKU, empty string if none",
            "taxable": "Required, whether taxable, boolean type",
            "title": "Required, line item title",
            "total_discount": "Required, line item total discount amount, string type",
            "total_discount_set": {
              "shop_money": {
                "amount": "Required, shop currency total discount amount, string type",
                "currency_code": "Required, shop currency code"
              },
              "presentment_money": {
                "amount": "Required, presentment currency total discount amount, string type",
                "currency_code": "Required, presentment currency code"
              }
            },
            "variant_id": "Required, associated product variant ID, numeric type",
            "variant_inventory_management": "Optional, variant inventory management method",
            "variant_title": "Optional, variant title, null if none",
            "vendor": "Required, vendor name",
            "tax_lines": [
              {
                "channel_liable": "Required, whether channel is liable for tax, boolean type",
                "price": "Required, tax amount, string type",
                "price_set": {
                  "shop_money": {
                    "amount": "Required, shop currency tax amount, string type",
                    "currency_code": "Required, shop currency code"
                  },
                  "presentment_money": {
                    "amount": "Required, presentment currency tax amount, string type",
                    "currency_code": "Required, presentment currency code"
                  }
                },
                "rate": "Required, tax rate, numeric type",
                "title": "Required, tax title"
              }
            ],
            "duties": [
              {
                "id": "Required, duty unique identifier, numeric type",
                "admin_graphql_api_id": "Optional, duty unique identifier in GraphQL API",
                "country_code_of_origin": "Optional, country of origin code",
                "harmonized_system_code": "Optional, harmonized system code, null if none",
                "price_set": {
                  "shop_money": {
                    "amount": "Required, shop currency duty amount, string type",
                    "currency_code": "Required, shop currency code"
                  },
                  "presentment_money": {
                    "amount": "Required, presentment currency duty amount, string type",
                    "currency_code": "Required, presentment currency code"
                  }
                },
                "tax_lines": "Required, duty tax lines list, empty array if none"
              }
            ],
            "discount_allocations": "Required, discount allocations list, empty array if none"
          }
        }
      ],
      "duties": "Required, duties list, empty array if none"
    }
  ],
  "shipping_address": {
    "first_name": "Required, shipping address first name",
    "address1": "Required, shipping address line 1",
    "phone": "Optional, shipping address phone number, null if none",
    "city": "Required, shipping address city",
    "zip": "Required, shipping address postal code",
    "province": "Required, shipping address province",
    "country": "Required, shipping address country",
    "last_name": "Required, shipping address last name",
    "address2": "Optional, shipping address line 2, null if none",
    "company": "Optional, shipping address company name, null if none",
    "latitude": "Required, shipping address latitude, numeric type",
    "longitude": "Required, shipping address longitude, numeric type",
    "name": "Required, shipping address full name",
    "country_code": "Required, shipping address country code",
    "province_code": "Required, shipping address province code"
  },
  "shipping_lines": [
    {
      "id": "Required, shipping line unique identifier, numeric type",
      "carrier_identifier": "Optional, carrier identifier, null if none",
      "code": "Optional, shipping line code",
      "discounted_price": "Required, discounted shipping price, string type",
      "discounted_price_set": {
        "shop_money": {
          "amount": "Required, shop currency discounted shipping price, string type",
          "currency_code": "Required, shop currency code"
        },
        "presentment_money": {
          "amount": "Required, presentment currency discounted shipping price, string type",
          "currency_code": "Required, presentment currency code"
        }
      },
      "is_removed": "Optional, whether removed, boolean type",
      "phone": "Optional, shipping line phone number, null if none",
      "price": "Required, shipping price, string type",
      "price_set": {
        "shop_money": {
          "amount": "Required, shop currency shipping price, string type",
          "currency_code": "Required, shop currency code"
        },
        "presentment_money": {
          "amount": "Required, presentment currency shipping price, string type",
          "currency_code": "Required, presentment currency code"
        }
      },
      "requested_fulfillment_service_id": "Optional, requested fulfillment service ID, null if none",
      "source": "Required, shipping source (e.g., shopify)",
      "title": "Required, shipping line title",
      "tax_lines": [
        {
          "channel_liable": "Optional, whether channel is liable for tax, boolean type",
          "price": "Required, tax amount, string type",
          "price_set": {
            "shop_money": {
              "amount": "Required, shop currency tax amount, string type",
              "currency_code": "Required, shop currency code"
            },
            "presentment_money": {
              "amount": "Required, presentment currency tax amount, string type",
              "currency_code": "Required, presentment currency code"
            }
          },
          "rate": "Required, tax rate, numeric type",
          "title": "Required, tax title"
        }
      ],
      "discount_allocations": "Required, discount allocations list, empty array if none"
    }
  ]
}

Last updated

Was this helpful?