Order
An order is a customer’s request to purchase one or more products from a shop. You can create, retrieve, update, and delete orders using the Order resource.
Representations
All representations are JSON objects submitted or received as payload to API requests or responses.
Order
app_id -integer -The ID of the app that created the order.
billing_address - address - The mailing address associated with the payment method. This address is an optional field that won’t be available on orders that do not require a payment method. It has the following properties:
browser_ip - string - The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported.
buyer_accepts_marketing - boolean - Whether the customer consented to receive email updates from the shop.
cancel_reason - string - The reason why the order was canceled. Valid values include :
- customer: The customer canceled the order.
- fraud: The order was fraudulent.
- inventory: Items in the order were not in inventory.
- declined: The payment was declined.
- other: A reason not in this list.
cancelled_at - The date and time when the order was canceled. Returns null if the order isn’t canceled.
cart_token - string -A unique value when referencing the cart that’s associated with the order.
checkout_token - string - A unique value when referencing the checkout that’s associated with the order.
client_details - Information about the browser that the customer used when they placed their order:
- accept_language: The languages and locales that the browser understands.
- browser_height: The browser screen height in pixels, if available.
- browser_ip: The browser IP address.
- browser_width: The browser screen width in pixels, if available.
- session_hash: A hash of the session.
- user_agent: Details of the browsing client, including software and operating versions.
closed_at - The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn’t closed.
created_at - The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed.
currency - string - The three-letter code (ISO 4217 format) for the shop currency.
current_total_discounts - string - The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
current_total_discounts_set - object- The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
current_total_duties_set - object - The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
current_total_price - string - The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
current_total_price_set - object - The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
current_subtotal_price - string - The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
current_subtotal_price_set - object - The current subtotal price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
current_total_tax - string - The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds.
current_total_tax_set - object - The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
customer - customer - Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null if the order was created through Shopify POS. For more information about the customer object, see the Customer resource.
customer_locale - string - The two or three-letter language code, optionally followed by a region modifier.
discount_applications - array - An ordered list of stacked discount applications.
The discount_applications property includes 3 types: discount_code, manual, and script. All 3 types share a common structure and have some type specific attributes.
discount_codes - array - A list of discounts applied to the order. Each discount object includes the following properties:
- amount: The amount that’s deducted from the order total. When you create an order, this value is the percentage or monetary amount to deduct. After the order is created, this property returns the calculated amount.
- code: When the associated discount application is of type code, this property returns the discount code that was entered at checkout. Otherwise this property returns the title of the discount that was applied.
- type: The type of discount. Default value: fixed_amount. Valid values:
- fixed_amount: Applies amount as a unit of the store’s currency. For example, if amount is 30 and the store’s currency is USD, then 30 USD is deducted from the order total when the discount is applied.
- percentage: Applies a discount of amount as a percentage of the order total.
- shipping: Applies a free shipping discount on orders that have a shipping rate less than or equal to amount. For example, if amount is 30, then the discount will give the customer free shipping for any shipping rate that is less than or equal to $30.
email - string - The customer’s email address.
estimated_taxes - boolean - Whether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. This property returns false when taxes on the order are finalized and aren’t subject to any changes.
financial_status - string - The status of payments associated with the order. Can only be set when the order is created. Valid values:
- pending: The payments are pending. Payment might fail in this state.
- Check again to confirm whether the payments have been paid successfully.
- authorized: The payments have been authorized.
- partially_paid: The order has been partially paid.
- paid: The payments have been paid.
- partially_refunded: The payments have been partially refunded.
- refunded: The payments have been refunded.
- voided: The payments have been voided.
fulfillments - array - An array of fulfillments associated with the order. For more information, see the Fulfillment API.
fulfillment_status - string - The order’s status in terms of fulfilled line items. You can use the FulfillmentOrder resource for a more granular view. Valid values:
- fulfilled: Every line item in the order has been fulfilled.
- null: None of the line items in the order have been fulfilled.
- partial: At least one line item in the order has been fulfilled.
- restocked: Every line item in the order has been restocked and the order canceled.
gateway - string - The payment gateway used.
id - integer - The ID of the order, used for API purposes. This is different from the order_number property, which is the ID used by the shop owner and customer.
landing_site - string - The URL for the page where the buyer landed when they entered the shop.
line_items - line_items properties array - A list of line item objects, each containing information about an item in the order. Each object has the listed properties as depicted in the line_items properties array .
location_id - integer - The ID of the physical location where the order was processed. To determine the locations where the line items are
assigned for fulfillment please use the FulfillmentOrder resource.
name - string - The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant’s general settings. This is different from the id property, which is the ID of the order used by the API. This field can also be set by the API to be any string value.
note - string - An optional note that a shop owner can attach to the order.
note_attributes -array - Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys.
number - integer - The order’s position in the shop’s count of orders. Numbers are sequential and start at 1.
order_number - integer - The order ‘s position in the shop’s count of orders starting at 1001. Order numbers are sequential and start at 1001.
original_total_duties_set - object - The original total duties charged on the order in shop and presentment currencies.
payment_details - string - An object containing information about the payment. It has the following properties:
- avs_result_code: The response code from the address verification system (AVS). The code is a single letter. See this chart for the codes and their definitions.
- credit_card_bin: The issuer identification number (IIN), formerly known as the bank identification number (BIN), of the customer’s credit card. This is made up of the first few digits of the credit card number.
- credit_card_company: The name of the company who issued the customer’s credit card.
- credit_card_number: The customer’s credit card number, with most of the leading digits redacted.
- cvv_result_code: The response code from the credit card company indicating whether the customer entered the card security code (card verification value) correctly. The code is a single letter or empty string. See this chart for the codes and their definitions.
payment_terms - object - The terms and conditions under which a payment should be processed.
- amount: The amount that is owed according to the payment terms.
- currency: The presentment currency for the payment.
- payment_terms_name: The name of the selected payment terms template for the order.
- payment_terms_type: The type of selected payment terms template for the order.
- due_in_days: The number of days between the invoice date and due date that is defined in the selected payment terms template.
- payment_schedules: An array of schedules associated to the payment terms.
- amount: The amount that is owed according to the payment terms.
- currency: The presentment currency for the payment.
- issued_at: The date and time when the payment terms were initiated.
- due_at: The date and time when the payment is due. Calculated based on issued_at and due_in_days or a customized fixed date if the type is fixed.
- completed_at: The date and time when the purchase is completed. Returns null initially and updates when the payment is captured.
- expected_payment_method: The name of the payment method gateway.
payment_gateway_names - array - The list of payment gateways used for the order.
phone - string -The customer’s phone number for receiving SMS notifications.
presentment_currency - string - The presentment currency that was used to display prices to the customer.
processed_at - The date and time (ISO 8601 format) when an order was processed. This value is the date that appears on your orders and that’s used in the analytic reports. If you’re importing orders from an app or another platform, then you can set processed_at to a date and time in the past to match when the original order was created.
processing_method - string - How the payment was processed. It has the following valid values:
- checkout: The order was processed using the Shopify checkout.
- direct: The order was processed using a direct payment provider.
- manual: The order was processed using a manual payment method.
- offsite: The order was processed by an external payment provider to the Shopify checkout.
- express: The order was processed using PayPal Express Checkout.
- free: The order was processed as a free order using a discount code.
referring_site - string - The website URL where the customer clicked a link to the shop.
refunds - array - A list of refunds applied to the order. For more information, see the Refund API.
shipping_address - CustomerAddress - The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
shipping_lines - array - An array of objects, each of which details a shipping method used. Each object has the following properties:
- code: A reference to the shipping method.
- discounted_price: The price of the shipping method after line-level discounts have been applied. Doesn’t reflect cart-level or order-level discounts.
- discounted_price_set: The price of the shipping method in both shop and presentment currencies after line-level discounts have been applied.
- price: The price of this shipping method in the shop currency. Can’t be negative.
- price_set: The price of the shipping method in shop and presentment currencies.
- source: The source of the shipping method.
- title: The title of the shipping method.
- tax_lines: A list of tax line objects, each of which details a tax applicable to this shipping line.
- carrier_identifier: A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
- requested_fulfillment_service_id: A reference to the fulfillment service that is being requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service; null otherwise.
source_name - string - The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. You can register the channels that your app is managing by completing this Google Form. After you’ve submited your request, you need to wait for your request to be processed by Shopify. You can find a list of your channels in the Partner Dashboard, in your app’s Marketplace extension. You can specify a handle as the source_name value in your request.
source_identifier - string - The ID of the order placed on the originating platform. This value doesn’t correspond to the Shopify ID that’s generated from a completed draft.
source_url - string - A valid URL to the original order on the originating surface. This URL is displayed to merchants on the Order Details page. If the URL is invalid, then it won’t be displayed.
subtotal_price - number - The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
subtotal_price_set - object - The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips.
tags - string - Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
tax_lines - array - An array of tax line objects, each of which details a tax applicable to the order. Each object has the following properties:
- price: The amount of tax to be charged in the shop currency. rate: The rate of tax to be applied.
- title: The name of the tax.
- channel_liable: Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for the tax line.
When creating an order through the API, tax lines can be specified on the order or the line items but not both. Tax lines specified on the order are split across the taxable line items in the created order.
taxes_included - boolean - Whether taxes are included in the order subtotal.
test - boolean - Whether this is a test order.
token - string - A unique value when referencing the order.
total_discounts - string - The total discounts applied to the price of the order in the shop currency.
total_discounts_set - object - The total discounts applied to the price of the order in shop and presentment currencies.
total_line_items_price - string - The sum of all line item prices in the shop currency.
total_line_items_price_set object - The total of all line item prices in shop and presentment currencies.
total_outstanding - string -The total outstanding amount of the order in the shop currency.
total_price - string - The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
total_price_set - object - The total price of the order in shop and presentment currencies.
total_shipping_price_set - object - The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true, then total_shipping_price_set includes taxes.
total_tax - string - The sum of all the taxes applied to the order in the shop currency. Must be positive.
total_tax_set - object - The total tax applied to the order in shop and presentment currencies.
total_tip_received - string - The sum of all the tips in the order in the shop currency.
total_weight - number - The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
updated_at - string - The date and time (ISO 8601 format) when the order was last modified.
user_id - integer - The ID of the user logged into Shopify POS who processed the order, if applicable.
order_status_url - string - The URL pointing to the order status web page, if applicable.
REST Endpoints
Create an order
An order is a customer’s request to purchase one or more products from a shop. The create request allows the custom order requiremets to be fullfilled.
Endpoint: /api/orders
Method: POST
OAuth 2.0 Scopes: Tenant authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"admin_graphql_api_id": "string",
"app_id": 0,
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"browser_ip": "string",
"buyer_accepts_marketing": true,
"cancel_reason": "string",
"cancelled_at": "string",
"cart_token": "string",
"checkout_id": "string",
"checkout_token": "string",
"client_details": {
"accept_language": "string",
"browser_height": "string",
"browser_ip": "string",
"browser_width": "string",
"session_hash": "string",
"user_agent": "string"
},
"closed_at": "2022-06-22T10:50:46.121Z",
"confirmed": true,
"contact_email": "string",
"created_at": "2022-06-22T10:50:46.121Z",
"currency": "string",
"current_subtotal_price": 0,
"current_subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_duties": 0,
"current_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_price": 0,
"current_total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_tax": 0,
"current_total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"customer": {
"accepts_marketing": true,
"accepts_marketing_updated_at": "2022-06-22T10:50:46.121Z",
"addresses": [
{
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
}
],
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.121Z",
"currency": "string",
"default_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"last_order_id": "string",
"last_order_name": "string",
"marketing_opt_in_level": "single_opt_in",
"multipass_identifier": "string",
"note": "string",
"orders_count": 0,
"phone": "string",
"state": "disabled",
"tags": "string",
"tax_exempt": true,
"tax_exemptions": [
"string"
],
"total_spent": 0,
"twc_customer_id": "string",
"updated_at": "2022-06-22T10:50:46.121Z",
"verified_email": true
},
"customer_locale": "string",
"device_id": "string",
"discount_applications": [
{
"allocation_method": "string",
"code": "string",
"description": "string",
"target_selection": "string",
"target_type": "string",
"type": "string",
"value": "string",
"value_type": "string"
}
],
"discount_codes": [
{
"amount": "string",
"code": "string",
"type": "string"
}
],
"email": "string",
"estimated_taxes": true,
"financial_status": "pending",
"fulfillment_status": "string",
"fulfillments": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.121Z",
"id": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"order_id": "string",
"receipt": {
"authorization": "string",
"testcase": true
},
"service": "string",
"shipment_status": "label_printed",
"status": "pending",
"tracking_company": "string",
"tracking_number": "string",
"tracking_numbers": [
"string"
],
"tracking_url": "string",
"tracking_urls": [
"string"
],
"updated_at": "2022-06-22T10:50:46.122Z"
}
],
"gateway": "string",
"id": 0,
"landing_site": "string",
"landing_site_ref": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"note": "string",
"note_attributes": [
{
"name": "string",
"value": "string"
}
],
"number": 0,
"order_number": 0,
"order_status_url": "string",
"original_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"payment_details": {
"avs_result_code": "string",
"credit_card_bin": "string",
"credit_card_company": "string",
"credit_card_expiration_month": 0,
"credit_card_expiration_year": 0,
"credit_card_name": "string",
"credit_card_number": "string",
"credit_card_wallet": "string",
"cvv_result_code": "string",
"id": "string"
},
"payment_gateway_names": [
"string"
],
"phone": "string",
"presentment_currency": "string",
"processed_at": "2022-06-22T10:50:46.122Z",
"processing_method": "string",
"reference": "string",
"referring_site": "string",
"refunds": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.122Z",
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"id": "string",
"note": "string",
"order_adjustments": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"kind": "string",
"order_id": "string",
"reason": "string",
"refund_id": "string",
"tax_amount": 0,
"tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"order_id": "string",
"processed_at": "2022-06-22T10:50:46.122Z",
"refund_duties": [
{
"duty_id": 0,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 0,
"line_item": {
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
},
"line_item_id": 0,
"location_id": "string",
"quantity": 0,
"restock_type": "no_restock",
"subtotal": 0,
"subtotal_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"restock": true,
"total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"transactions": [
{
"admin_graphql_api_id": "string",
"amount": 0,
"authorization": "string",
"created_at": "2022-06-22T10:50:46.122Z",
"currency": "string",
"device_id": "string",
"error_code": "string",
"gateway": "string",
"id": "string",
"kind": "string",
"location_id": "string",
"message": "string",
"order_id": "string",
"parent_id": "string",
"processed_at": "2022-06-22T10:50:46.122Z",
"receipt": {
"authorization": "string",
"testcase": true
},
"source_name": "web",
"status": "pending",
"test": true,
"user_id": "string"
}
],
"user_id": "string"
}
],
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"shipping_lines": [
{
"carrier_identifier": "string",
"code": "string",
"delivery_category": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"discounted_price": "string",
"discounted_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"phone": "string",
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"requested_fulfillment_service_id": "string",
"source": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"title": "string"
}
],
"source_identifier": "string",
"source_name": "string",
"source_url": "string",
"status": "closed",
"subtotal_price": 0,
"subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"tags": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxes_included": true,
"test": true,
"token": "string",
"total_discounts": "string",
"total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_line_items_price": "string",
"total_line_items_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_outstanding": 0,
"total_price": 0,
"total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_price_usd": 0,
"total_shipping_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tip_received": 0,
"total_weight": 0,
"updated_at": "2022-06-22T10:50:46.122Z",
"user_id": "string"
}
{
"admin_graphql_api_id": "string",
"app_id": 0,
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"browser_ip": "string",
"buyer_accepts_marketing": true,
"cancel_reason": "string",
"cancelled_at": "string",
"cart_token": "string",
"checkout_id": "string",
"checkout_token": "string",
"client_details": {
"accept_language": "string",
"browser_height": "string",
"browser_ip": "string",
"browser_width": "string",
"session_hash": "string",
"user_agent": "string"
},
"closed_at": "2022-06-22T10:50:46.152Z",
"confirmed": true,
"contact_email": "string",
"created_at": "2022-06-22T10:50:46.153Z",
"currency": "string",
"current_subtotal_price": 0,
"current_subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_duties": 0,
"current_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_price": 0,
"current_total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_tax": 0,
"current_total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"customer": {
"accepts_marketing": true,
"accepts_marketing_updated_at": "2022-06-22T10:50:46.153Z",
"addresses": [
{
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
}
],
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.153Z",
"currency": "string",
"default_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"last_order_id": "string",
"last_order_name": "string",
"marketing_opt_in_level": "single_opt_in",
"multipass_identifier": "string",
"note": "string",
"orders_count": 0,
"phone": "string",
"state": "disabled",
"tags": "string",
"tax_exempt": true,
"tax_exemptions": [
"string"
],
"total_spent": 0,
"twc_customer_id": "string",
"updated_at": "2022-06-22T10:50:46.153Z",
"verified_email": true
},
"customer_locale": "string",
"device_id": "string",
"discount_applications": [
{
"allocation_method": "string",
"code": "string",
"description": "string",
"target_selection": "string",
"target_type": "string",
"type": "string",
"value": "string",
"value_type": "string"
}
],
"discount_codes": [
{
"amount": "string",
"code": "string",
"type": "string"
}
],
"email": "string",
"estimated_taxes": true,
"financial_status": "pending",
"fulfillment_status": "string",
"fulfillments": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.153Z",
"id": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"order_id": "string",
"receipt": {
"authorization": "string",
"testcase": true
},
"service": "string",
"shipment_status": "label_printed",
"status": "pending",
"tracking_company": "string",
"tracking_number": "string",
"tracking_numbers": [
"string"
],
"tracking_url": "string",
"tracking_urls": [
"string"
],
"updated_at": "2022-06-22T10:50:46.153Z"
}
],
"gateway": "string",
"id": 0,
"landing_site": "string",
"landing_site_ref": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"note": "string",
"note_attributes": [
{
"name": "string",
"value": "string"
}
],
"number": 0,
"order_number": 0,
"order_status_url": "string",
"original_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"payment_details": {
"avs_result_code": "string",
"credit_card_bin": "string",
"credit_card_company": "string",
"credit_card_expiration_month": 0,
"credit_card_expiration_year": 0,
"credit_card_name": "string",
"credit_card_number": "string",
"credit_card_wallet": "string",
"cvv_result_code": "string",
"id": "string"
},
"payment_gateway_names": [
"string"
],
"phone": "string",
"presentment_currency": "string",
"processed_at": "2022-06-22T10:50:46.153Z",
"processing_method": "string",
"reference": "string",
"referring_site": "string",
"refunds": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:50:46.153Z",
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"id": "string",
"note": "string",
"order_adjustments": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"kind": "string",
"order_id": "string",
"reason": "string",
"refund_id": "string",
"tax_amount": 0,
"tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"order_id": "string",
"processed_at": "2022-06-22T10:50:46.153Z",
"refund_duties": [
{
"duty_id": 0,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 0,
"line_item": {
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
},
"line_item_id": 0,
"location_id": "string",
"quantity": 0,
"restock_type": "no_restock",
"subtotal": 0,
"subtotal_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"restock": true,
"total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"transactions": [
{
"admin_graphql_api_id": "string",
"amount": 0,
"authorization": "string",
"created_at": "2022-06-22T10:50:46.153Z",
"currency": "string",
"device_id": "string",
"error_code": "string",
"gateway": "string",
"id": "string",
"kind": "string",
"location_id": "string",
"message": "string",
"order_id": "string",
"parent_id": "string",
"processed_at": "2022-06-22T10:50:46.153Z",
"receipt": {
"authorization": "string",
"testcase": true
},
"source_name": "web",
"status": "pending",
"test": true,
"user_id": "string"
}
],
"user_id": "string"
}
],
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"shipping_lines": [
{
"carrier_identifier": "string",
"code": "string",
"delivery_category": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"discounted_price": "string",
"discounted_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"phone": "string",
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"requested_fulfillment_service_id": "string",
"source": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"title": "string"
}
],
"source_identifier": "string",
"source_name": "string",
"source_url": "string",
"status": "closed",
"subtotal_price": 0,
"subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"tags": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxes_included": true,
"test": true,
"token": "string",
"total_discounts": "string",
"total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_line_items_price": "string",
"total_line_items_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_outstanding": 0,
"total_price": 0,
"total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_price_usd": 0,
"total_shipping_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tip_received": 0,
"total_weight": 0,
"updated_at": "2022-06-22T10:50:46.153Z",
"user_id": "string"
}
HTTP Status Code:
- 200 OK
- 201 created
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update an order
Updates an already existing order. the capabalities include addition and removal of items , discounts etc. If the order does not exist, this method returns a ResourceNotFound error.
Endpoint: /api/orders
Method: PUT
OAuth 2.0 Scopes: Tenant authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"admin_graphql_api_id": "string",
"app_id": 0,
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"browser_ip": "string",
"buyer_accepts_marketing": true,
"cancel_reason": "string",
"cancelled_at": "string",
"cart_token": "string",
"checkout_id": "string",
"checkout_token": "string",
"client_details": {
"accept_language": "string",
"browser_height": "string",
"browser_ip": "string",
"browser_width": "string",
"session_hash": "string",
"user_agent": "string"
},
"closed_at": "2022-06-22T10:59:06.107Z",
"confirmed": true,
"contact_email": "string",
"created_at": "2022-06-22T10:59:06.107Z",
"currency": "string",
"current_subtotal_price": 0,
"current_subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_duties": 0,
"current_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_price": 0,
"current_total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_tax": 0,
"current_total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"customer": {
"accepts_marketing": true,
"accepts_marketing_updated_at": "2022-06-22T10:59:06.107Z",
"addresses": [
{
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
}
],
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.107Z",
"currency": "string",
"default_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"last_order_id": "string",
"last_order_name": "string",
"marketing_opt_in_level": "single_opt_in",
"multipass_identifier": "string",
"note": "string",
"orders_count": 0,
"phone": "string",
"state": "disabled",
"tags": "string",
"tax_exempt": true,
"tax_exemptions": [
"string"
],
"total_spent": 0,
"twc_customer_id": "string",
"updated_at": "2022-06-22T10:59:06.107Z",
"verified_email": true
},
"customer_locale": "string",
"device_id": "string",
"discount_applications": [
{
"allocation_method": "string",
"code": "string",
"description": "string",
"target_selection": "string",
"target_type": "string",
"type": "string",
"value": "string",
"value_type": "string"
}
],
"discount_codes": [
{
"amount": "string",
"code": "string",
"type": "string"
}
],
"email": "string",
"estimated_taxes": true,
"financial_status": "pending",
"fulfillment_status": "string",
"fulfillments": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.107Z",
"id": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"order_id": "string",
"receipt": {
"authorization": "string",
"testcase": true
},
"service": "string",
"shipment_status": "label_printed",
"status": "pending",
"tracking_company": "string",
"tracking_number": "string",
"tracking_numbers": [
"string"
],
"tracking_url": "string",
"tracking_urls": [
"string"
],
"updated_at": "2022-06-22T10:59:06.108Z"
}
],
"gateway": "string",
"id": 0,
"landing_site": "string",
"landing_site_ref": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"note": "string",
"note_attributes": [
{
"name": "string",
"value": "string"
}
],
"number": 0,
"order_number": 0,
"order_status_url": "string",
"original_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"payment_details": {
"avs_result_code": "string",
"credit_card_bin": "string",
"credit_card_company": "string",
"credit_card_expiration_month": 0,
"credit_card_expiration_year": 0,
"credit_card_name": "string",
"credit_card_number": "string",
"credit_card_wallet": "string",
"cvv_result_code": "string",
"id": "string"
},
"payment_gateway_names": [
"string"
],
"phone": "string",
"presentment_currency": "string",
"processed_at": "2022-06-22T10:59:06.108Z",
"processing_method": "string",
"reference": "string",
"referring_site": "string",
"refunds": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.108Z",
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"id": "string",
"note": "string",
"order_adjustments": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"kind": "string",
"order_id": "string",
"reason": "string",
"refund_id": "string",
"tax_amount": 0,
"tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"order_id": "string",
"processed_at": "2022-06-22T10:59:06.108Z",
"refund_duties": [
{
"duty_id": 0,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 0,
"line_item": {
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
},
"line_item_id": 0,
"location_id": "string",
"quantity": 0,
"restock_type": "no_restock",
"subtotal": 0,
"subtotal_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"restock": true,
"total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"transactions": [
{
"admin_graphql_api_id": "string",
"amount": 0,
"authorization": "string",
"created_at": "2022-06-22T10:59:06.108Z",
"currency": "string",
"device_id": "string",
"error_code": "string",
"gateway": "string",
"id": "string",
"kind": "string",
"location_id": "string",
"message": "string",
"order_id": "string",
"parent_id": "string",
"processed_at": "2022-06-22T10:59:06.108Z",
"receipt": {
"authorization": "string",
"testcase": true
},
"source_name": "web",
"status": "pending",
"test": true,
"user_id": "string"
}
],
"user_id": "string"
}
],
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"shipping_lines": [
{
"carrier_identifier": "string",
"code": "string",
"delivery_category": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"discounted_price": "string",
"discounted_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"phone": "string",
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"requested_fulfillment_service_id": "string",
"source": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"title": "string"
}
],
"source_identifier": "string",
"source_name": "string",
"source_url": "string",
"status": "closed",
"subtotal_price": 0,
"subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"tags": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxes_included": true,
"test": true,
"token": "string",
"total_discounts": "string",
"total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_line_items_price": "string",
"total_line_items_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_outstanding": 0,
"total_price": 0,
"total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_price_usd": 0,
"total_shipping_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tip_received": 0,
"total_weight": 0,
"updated_at": "2022-06-22T10:59:06.108Z",
"user_id": "string"
}
{
"admin_graphql_api_id": "string",
"app_id": 0,
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"browser_ip": "string",
"buyer_accepts_marketing": true,
"cancel_reason": "string",
"cancelled_at": "string",
"cart_token": "string",
"checkout_id": "string",
"checkout_token": "string",
"client_details": {
"accept_language": "string",
"browser_height": "string",
"browser_ip": "string",
"browser_width": "string",
"session_hash": "string",
"user_agent": "string"
},
"closed_at": "2022-06-22T10:59:06.162Z",
"confirmed": true,
"contact_email": "string",
"created_at": "2022-06-22T10:59:06.162Z",
"currency": "string",
"current_subtotal_price": 0,
"current_subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_duties": 0,
"current_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_price": 0,
"current_total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_tax": 0,
"current_total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"customer": {
"accepts_marketing": true,
"accepts_marketing_updated_at": "2022-06-22T10:59:06.162Z",
"addresses": [
{
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
}
],
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.162Z",
"currency": "string",
"default_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"last_order_id": "string",
"last_order_name": "string",
"marketing_opt_in_level": "single_opt_in",
"multipass_identifier": "string",
"note": "string",
"orders_count": 0,
"phone": "string",
"state": "disabled",
"tags": "string",
"tax_exempt": true,
"tax_exemptions": [
"string"
],
"total_spent": 0,
"twc_customer_id": "string",
"updated_at": "2022-06-22T10:59:06.162Z",
"verified_email": true
},
"customer_locale": "string",
"device_id": "string",
"discount_applications": [
{
"allocation_method": "string",
"code": "string",
"description": "string",
"target_selection": "string",
"target_type": "string",
"type": "string",
"value": "string",
"value_type": "string"
}
],
"discount_codes": [
{
"amount": "string",
"code": "string",
"type": "string"
}
],
"email": "string",
"estimated_taxes": true,
"financial_status": "pending",
"fulfillment_status": "string",
"fulfillments": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.162Z",
"id": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"order_id": "string",
"receipt": {
"authorization": "string",
"testcase": true
},
"service": "string",
"shipment_status": "label_printed",
"status": "pending",
"tracking_company": "string",
"tracking_number": "string",
"tracking_numbers": [
"string"
],
"tracking_url": "string",
"tracking_urls": [
"string"
],
"updated_at": "2022-06-22T10:59:06.162Z"
}
],
"gateway": "string",
"id": 0,
"landing_site": "string",
"landing_site_ref": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"note": "string",
"note_attributes": [
{
"name": "string",
"value": "string"
}
],
"number": 0,
"order_number": 0,
"order_status_url": "string",
"original_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"payment_details": {
"avs_result_code": "string",
"credit_card_bin": "string",
"credit_card_company": "string",
"credit_card_expiration_month": 0,
"credit_card_expiration_year": 0,
"credit_card_name": "string",
"credit_card_number": "string",
"credit_card_wallet": "string",
"cvv_result_code": "string",
"id": "string"
},
"payment_gateway_names": [
"string"
],
"phone": "string",
"presentment_currency": "string",
"processed_at": "2022-06-22T10:59:06.162Z",
"processing_method": "string",
"reference": "string",
"referring_site": "string",
"refunds": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T10:59:06.162Z",
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"id": "string",
"note": "string",
"order_adjustments": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"kind": "string",
"order_id": "string",
"reason": "string",
"refund_id": "string",
"tax_amount": 0,
"tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"order_id": "string",
"processed_at": "2022-06-22T10:59:06.162Z",
"refund_duties": [
{
"duty_id": 0,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 0,
"line_item": {
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
},
"line_item_id": 0,
"location_id": "string",
"quantity": 0,
"restock_type": "no_restock",
"subtotal": 0,
"subtotal_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"restock": true,
"total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"transactions": [
{
"admin_graphql_api_id": "string",
"amount": 0,
"authorization": "string",
"created_at": "2022-06-22T10:59:06.162Z",
"currency": "string",
"device_id": "string",
"error_code": "string",
"gateway": "string",
"id": "string",
"kind": "string",
"location_id": "string",
"message": "string",
"order_id": "string",
"parent_id": "string",
"processed_at": "2022-06-22T10:59:06.162Z",
"receipt": {
"authorization": "string",
"testcase": true
},
"source_name": "web",
"status": "pending",
"test": true,
"user_id": "string"
}
],
"user_id": "string"
}
],
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"shipping_lines": [
{
"carrier_identifier": "string",
"code": "string",
"delivery_category": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"discounted_price": "string",
"discounted_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"phone": "string",
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"requested_fulfillment_service_id": "string",
"source": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"title": "string"
}
],
"source_identifier": "string",
"source_name": "string",
"source_url": "string",
"status": "closed",
"subtotal_price": 0,
"subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"tags": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxes_included": true,
"test": true,
"token": "string",
"total_discounts": "string",
"total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_line_items_price": "string",
"total_line_items_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_outstanding": 0,
"total_price": 0,
"total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_price_usd": 0,
"total_shipping_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tip_received": 0,
"total_weight": 0,
"updated_at": "2022-06-22T10:59:06.162Z",
"user_id": "string"
}
HTTP Status Code:
- 200 OK updated order
- 201 created
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Finds Order by status
Returns an order by its id from a specific Store while passing the respective id as a path param in the endpoint. If the order does not exist, this method returns a ResourceNotFound error.
Endpoint: /api/orders/{id}
Method: GET
OAuth 2.0 Scopes: Tenant authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
- {id}
{
"admin_graphql_api_id": "string",
"app_id": 0,
"billing_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"browser_ip": "string",
"buyer_accepts_marketing": true,
"cancel_reason": "string",
"cancelled_at": "string",
"cart_token": "string",
"checkout_id": "string",
"checkout_token": "string",
"client_details": {
"accept_language": "string",
"browser_height": "string",
"browser_ip": "string",
"browser_width": "string",
"session_hash": "string",
"user_agent": "string"
},
"closed_at": "2022-06-22T11:05:46.485Z",
"confirmed": true,
"contact_email": "string",
"created_at": "2022-06-22T11:05:46.485Z",
"currency": "string",
"current_subtotal_price": 0,
"current_subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_duties": 0,
"current_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_price": 0,
"current_total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"current_total_tax": 0,
"current_total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"customer": {
"accepts_marketing": true,
"accepts_marketing_updated_at": "2022-06-22T11:05:46.485Z",
"addresses": [
{
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
}
],
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T11:05:46.485Z",
"currency": "string",
"default_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"last_order_id": "string",
"last_order_name": "string",
"marketing_opt_in_level": "single_opt_in",
"multipass_identifier": "string",
"note": "string",
"orders_count": 0,
"phone": "string",
"state": "disabled",
"tags": "string",
"tax_exempt": true,
"tax_exemptions": [
"string"
],
"total_spent": 0,
"twc_customer_id": "string",
"updated_at": "2022-06-22T11:05:46.486Z",
"verified_email": true
},
"customer_locale": "string",
"device_id": "string",
"discount_applications": [
{
"allocation_method": "string",
"code": "string",
"description": "string",
"target_selection": "string",
"target_type": "string",
"type": "string",
"value": "string",
"value_type": "string"
}
],
"discount_codes": [
{
"amount": "string",
"code": "string",
"type": "string"
}
],
"email": "string",
"estimated_taxes": true,
"financial_status": "pending",
"fulfillment_status": "string",
"fulfillments": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T11:05:46.486Z",
"id": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"order_id": "string",
"receipt": {
"authorization": "string",
"testcase": true
},
"service": "string",
"shipment_status": "label_printed",
"status": "pending",
"tracking_company": "string",
"tracking_number": "string",
"tracking_numbers": [
"string"
],
"tracking_url": "string",
"tracking_urls": [
"string"
],
"updated_at": "2022-06-22T11:05:46.486Z"
}
],
"gateway": "string",
"id": 0,
"landing_site": "string",
"landing_site_ref": "string",
"line_items": [
{
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
}
],
"location_id": "string",
"name": "string",
"note": "string",
"note_attributes": [
{
"name": "string",
"value": "string"
}
],
"number": 0,
"order_number": 0,
"order_status_url": "string",
"original_total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"payment_details": {
"avs_result_code": "string",
"credit_card_bin": "string",
"credit_card_company": "string",
"credit_card_expiration_month": 0,
"credit_card_expiration_year": 0,
"credit_card_name": "string",
"credit_card_number": "string",
"credit_card_wallet": "string",
"cvv_result_code": "string",
"id": "string"
},
"payment_gateway_names": [
"string"
],
"phone": "string",
"presentment_currency": "string",
"processed_at": "2022-06-22T11:05:46.486Z",
"processing_method": "string",
"reference": "string",
"referring_site": "string",
"refunds": [
{
"admin_graphql_api_id": "string",
"created_at": "2022-06-22T11:05:46.486Z",
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"id": "string",
"note": "string",
"order_adjustments": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"kind": "string",
"order_id": "string",
"reason": "string",
"refund_id": "string",
"tax_amount": 0,
"tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"order_id": "string",
"processed_at": "2022-06-22T11:05:46.486Z",
"refund_duties": [
{
"duty_id": 0,
"refund_type": "FULL"
}
],
"refund_line_items": [
{
"id": 0,
"line_item": {
"admin_graphql_api_id": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"duties": [
{
"admin_graphql_api_id": "string",
"country_code_of_origin": "string",
"harmonized_system_code": "string",
"id": "string",
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
},
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
]
}
],
"fulfillable_quantity": 0,
"fulfillment_service": "string",
"fulfillment_status": "string",
"gift_card": true,
"grams": 0,
"id": "string",
"name": "string",
"price": 0,
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"product_exists": true,
"product_id": "string",
"properties": [
{
"name": "string",
"value": "string"
}
],
"quantity": 0,
"requires_shipping": true,
"sku": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxable": true,
"title": "string",
"total_discount": 0,
"total_discount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"variant_id": "string",
"variant_inventory_management": "string",
"variant_title": "string",
"vendor": "string"
},
"line_item_id": 0,
"location_id": "string",
"quantity": 0,
"restock_type": "no_restock",
"subtotal": 0,
"subtotal_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
}
}
],
"restock": true,
"total_duties_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"transactions": [
{
"admin_graphql_api_id": "string",
"amount": 0,
"authorization": "string",
"created_at": "2022-06-22T11:05:46.486Z",
"currency": "string",
"device_id": "string",
"error_code": "string",
"gateway": "string",
"id": "string",
"kind": "string",
"location_id": "string",
"message": "string",
"order_id": "string",
"parent_id": "string",
"processed_at": "2022-06-22T11:05:46.486Z",
"receipt": {
"authorization": "string",
"testcase": true
},
"source_name": "web",
"status": "pending",
"test": true,
"user_id": "string"
}
],
"user_id": "string"
}
],
"shipping_address": {
"address1": "string",
"address2": "string",
"city": "string",
"company": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"customer_id": "string",
"default": true,
"email": "string",
"first_name": "string",
"id": "string",
"last_name": "string",
"latitude": 0,
"longitude": 0,
"name": "string",
"phone": "string",
"province": "string",
"province_code": "string",
"zip": "string"
},
"shipping_lines": [
{
"carrier_identifier": "string",
"code": "string",
"delivery_category": "string",
"discount_allocations": [
{
"amount": 0,
"amount_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"discount_application_index": 0
}
],
"discounted_price": "string",
"discounted_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"id": "string",
"phone": "string",
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"requested_fulfillment_service_id": "string",
"source": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"title": "string"
}
],
"source_identifier": "string",
"source_name": "string",
"source_url": "string",
"status": "closed",
"subtotal_price": 0,
"subtotal_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"tags": "string",
"tax_lines": [
{
"channel_liable": true,
"price": "string",
"price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"rate": 0,
"title": "string"
}
],
"taxes_included": true,
"test": true,
"token": "string",
"total_discounts": "string",
"total_discounts_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_line_items_price": "string",
"total_line_items_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_outstanding": 0,
"total_price": 0,
"total_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_price_usd": 0,
"total_shipping_price_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tax": 0,
"total_tax_set": {
"presentment_money": {
"amount": "string",
"currency_code": "string"
},
"shop_money": {
"amount": "string",
"currency_code": "string"
}
},
"total_tip_received": 0,
"total_weight": 0,
"updated_at": "2022-06-22T11:05:46.487Z",
"user_id": "string"
}
HTTP Status Code:
- 200 OK
- 201 created
- 400 Invalid status value
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 405 Invalid input