Shopify API
DtoShopifyWebhookCreateOrderBody
The globally-unique identifier of the Order in store within Shopify (used as trackCode)
The ID of the app in Shopify for graphQl.
The ID of the app that created the order.
Whether the customer agreed to receive marketing materials.
The reason provided when the order was canceled. Returns null if the order wasn't canceled.
The date and time when the order was canceled. Returns null if the order wasn't canceled.
A unique value when referencing the checkout that's associated with the order.
A unique value when referencing the checkout that's associated with the order.
Information about the browser that the customer used when they placed their order:
The languages and locales that the browser understands.
The browser screen height in pixels, if available.
The browser IP address.
The browser screen width in pixels, if available.
A hash of the session.
Details of the browsing client, including software and operating versions.
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
Whether inventory has been reserved for the order.
The email address associated with the customer or contact.
The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed.
The three-letter code (ISO 4217 format) for the shop currency.
The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
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.
Amount in shop currency.
Amount in presentment currency.
The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
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.
Amount in shop currency.
Amount in presentment currency.
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.
Amount in shop currency.
Amount in presentment currency.
The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
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.
Amount in shop currency.
Amount in presentment currency.
The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds.
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.
Amount in shop currency.
Amount in presentment currency.
The two or three-letter language code, optionally followed by a region modifier.
The ID for the device.
A list of discounts applied to the order. Each discount object includes the following properties:
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.
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.
The type of discount. Default value: fixed_amount.
The customer's email address.
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.
The status of payments associated with the order. Can only be set when the order is created.
The order's status in terms of fulfilled line items.
The payment gateway used.
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.
An optional note that a shop owner can attach to the order.
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.
The order's position in the shop's count of orders. Numbers are sequential and start at 1.
The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001.
The URL pointing to the order status web page
The original total duties charged on the order in shop and presentment currencies.
Amount in shop currency.
Amount in presentment currency.
The list of payment gateways used for the order.
The customer's phone number for receiving SMS notifications.
The presentment currency that was used to display prices to the customer.
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.
How the payment was processed.
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips.
Amount in shop currency.
Amount in presentment currency.
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.
An array of tax line objects, each of which details a tax applicable to the order.
The amount of tax to be charged in the shop currency.
The rate of tax to be applied.
The name of the tax.
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.
Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for the tax line.
Whether taxes are included in the order subtotal.
Whether this is a test order.
A unique value when referencing the order.
The total discounts applied to the price of the order in the shop currency.
The total discounts applied to the price of the order in shop and presentment currencies.
Amount in shop currency.
Amount in presentment currency.
The sum of all line item prices in the shop currency.
The total of all line item prices in shop and presentment currencies.
Amount in shop currency.
Amount in presentment currency.
The total outstanding amount of the order in the shop currency.
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
The total price of the order in shop and presentment currencies.
Amount in shop currency.
Amount in presentment currency.
The total price of the order in USD.
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.
Amount in shop currency.
Amount in presentment currency.
The sum of all the taxes applied to the order in the shop currency. Must be positive.
The total tax applied to the order in shop and presentment currencies.
Amount in shop currency.
Amount in presentment currency.
The sum of all the tips in the order in the shop currency.
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
The date and time (ISO 8601 format) when the order was last modified. Filtering orders by updated_at is not an effective method for fetching orders because its value can change when no visible fields of an order have been updated.
The ID of the user logged into Shopify POS who processed the order, if applicable.
'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:'
A unique identifier for the address.
A unique identifier for the customer.
The first name of the person associated with the payment method.
The last name of the person associated with the payment method.
The company of the person associated with the billing address.
The street address of the billing address.
An optional additional field for the street address of the billing address.
The city, town, or village of the billing address.
The name of the region (for example, province, state, or prefecture) of the billing address.
The name of the country of the billing address.
The postal code (for example, zip, postcode, or Eircode) of the billing address.
The phone number at the billing address.
The full name of the person associated with the payment method.
The latitude of the billing address.
The longitude of the billing address.
The two-letter code (ISO 3166-1 format) for the country of the billing address.
The two-letter abbreviation of the region of the billing address.
The customer's normalized country name.
Returns true for each default address.
A unique identifier for the customer.
The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.
As of API version 2022-04, this field is deprecated. Use email_marketing_consent instead. Whether the customer has consented to receive marketing material by email.
The date and time (ISO 8601 format) when the customer was created.
The date and time (ISO 8601 format) when the customer information was last updated
The customer's first name.
The customer's last name.
The number of orders associated with this customer. Test and archived orders aren't counted.
'The state of the customer's account with a shop. Default value: disabled. Valid values:'
The total amount of money that the customer has spent across their order history.
The ID of the customer's last order.
A note about the customer.
Whether the customer has verified their email address.
A unique identifier for the customer that's used with ' 'Multipass login.
Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout.
The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world.
Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters.
The name of the customer's last order. This is directly related to the name field on the Order resource.
he three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.
As of API version 2022-04, this field is deprecated. Use email_marketing_consent instead. The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. Set this value whenever the customer consents or objects to marketing materials.
'Whether the customer is exempt from paying specific taxes on their order. Canadian taxes only. Valid values:'
A unique identifier for the customer for Api GraphQl.
'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:'
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.
The method by which the discount application value has been allocated to entitled lines.
The discount code that was used to apply the discount. Available only for discount code applications.
The description of the discount application, as defined by the merchant or the Shopify Script. Available only for manual and script discount applications.
The lines on the order, of the type defined by target_type, that the discount is allocated over.
The type of line on the order that the discount is applicable on.
The title of the discount application, as defined by the merchant. Available only for manual discount applications.
The discount application type.
The value of the discount application as a decimal. This represents the intention of the discount application. For example, if the intent was to apply a 20% discount, then the value will be 20.0. If the intent was to apply a $15 discount, then the value will be 15.0.
The type of the value.
An array of fulfillments associated with the order.
Item identifier
Grams per item
Name of the item
Price per item
Number that identifies a product
Wether the item needs to me shipped or not
Wether the item is taxable or not
The terms and conditions under which a payment should be processed.
The amount that is owed according to the payment terms.
The presentment currency for the payment.
The name of the selected payment terms template for the order.
The type of selected payment terms template for the order.
The number of days between the invoice date and due date that is defined in the selected payment terms template.
An array of schedules associated to the payment terms.
A list of refunds applied to the order.
The unique identifier for the refund.
The unique identifier for the order that the order adjustment is associated with.
The date and time (ISO 8601 format) when the refund was created.
An optional note attached to a refund.
The unique identifier of the user who performed the refund.
The date and time (ISO 8601 format) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in Shopify. Public apps need to be granted permission by Shopify to import orders with the processed_at timestamp set to a value earlier the created_at timestamp. Private apps can't be granted permission by Shopify.
'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:'
'An array of objects, each of which details a shipping method used. Each object has the following properties:'
A unique identifier for the shipping line.
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
A reference to the shipping method.
The general classification of the delivery method.
The price of the shipping method after line-level discounts have been applied. Doesn't reflect cart-level or order-level discounts.
The price of the shipping method in both shop and presentment currencies after line-level discounts have been applied.
The phone number at the shipping address.
The price of this shipping method in the shop currency. Can't be negative.
The price of the shipping method in shop and presentment currencies.
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.
The source of the shipping method.
The title of the shipping method.
A list of tax line objects, each of which details a tax applicable to this shipping line.
The discounts that have been allocated to the shipping line.
1{2"id": 4693237498081,3"admin_graphql_api_id": "gid://shopify/Order/XXXXXXXXXXXXX",4"app_id": 580119,5"buyer_accepts_marketing": false,6"cancel_reason": null,7"cancelled_at": "null",8"checkout_id": 32514734653665,9"checkout_token": "ba416ed5402868d5a0fec4089f27ds7e",10"client_details": {11"accept_language": "es",12"browser_height": "900",13"browser_ip": "xxx.xxx.xxx.xxx",14"browser_width": "1000",15"session_hash": "9ad4d1f4e6a8977b9dd98eed1e477643",16"user_agent": "Mozilla/X.0 (X11; Linux x86_64) AppleWebKit/xxxxx (KHTML, like Gecko) Chrome/xxxxxx Safari/xxxxx"17},18"closed_at": "2008-01-10T11:00:00-05:00",19"confirmed": true,20"contact_email": "test@mail.example.com",21"created_at": "2012-03-13T16:09:55-04:00",22"currency": "CLP",23"current_subtotal_price": 100,24"current_subtotal_price_set": {25"shop_money": {26"amount": "100",27"currency_code": "CLP"28},29"presentment_money": {30"amount": "100",31"currency_code": "CLP"32}33},34"current_total_discounts": 0,35"current_total_discounts_set": {36"shop_money": {37"amount": "100",38"currency_code": "CLP"39},40"presentment_money": {41"amount": "100",42"currency_code": "CLP"43}44},45"current_total_duties_set": {46"shop_money": {47"amount": "100",48"currency_code": "CLP"49},50"presentment_money": {51"amount": "100",52"currency_code": "CLP"53}54},55"current_total_price": 626,56"current_total_price_set": {57"shop_money": {58"amount": "100",59"currency_code": "CLP"60},61"presentment_money": {62"amount": "100",63"currency_code": "CLP"64}65},66"current_total_tax": 19,67"current_total_tax_set": {68"shop_money": {69"amount": "100",70"currency_code": "CLP"71},72"presentment_money": {73"amount": "100",74"currency_code": "CLP"75}76},77"customer_locale": "es",78"device_id": null,79"discount_codes": [80{81"code": "SPRING30",82"amount": "30.00",83"type": "fixed_amount"84}85],86"email": "shopping@mail.example.com",87"estimated_taxes": false,88"financial_status": "paid",89"fulfillment_status": "fulfilled",90"gateway": "shopify_payments",91"name": "#1032",92"note": "Customer changed their mind.",93"note_attributes": [94{95"name": "custom name",96"value": "custom value"97}98],99"number": 32,100"order_number": 1032,101"order_status_url": "https://checkout.shopify.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35",102"original_total_duties_set": {103"shop_money": {104"amount": "100",105"currency_code": "CLP"106},107"presentment_money": {108"amount": "100",109"currency_code": "CLP"110}111},112"payment_gateway_names": [113"authorize_net",114"bogus"115],116"phone": "+557734881234",117"presentment_currency": "CLP",118"processed_at": "2022-03-11T18:48:56-05:00",119"processing_method": "checkout",120"subtotal_price": 100,121"subtotal_price_set": {122"shop_money": {123"amount": "100",124"currency_code": "CLP"125},126"presentment_money": {127"amount": "100",128"currency_code": "CLP"129}130},131"tags": "loyal",132"tax_lines": {133"price": 19,134"rate": 0.19,135"title": "VAT",136"price_set": {137"shop_money": {},138"presentment_money": {}139},140"channel_liable": false141},142"taxes_included": false,143"test": true,144"token": "912aa9359d838d6dc7d402158816ef50",145"total_discounts": "0.00",146"total_discounts_set": {147"shop_money": {148"amount": "100",149"currency_code": "CLP"150},151"presentment_money": {152"amount": "100",153"currency_code": "CLP"154}155},156"total_line_items_price": 100,157"total_line_items_price_set": {158"shop_money": {159"amount": "100",160"currency_code": "CLP"161},162"presentment_money": {163"amount": "100",164"currency_code": "CLP"165}166},167"total_outstanding": 0,168"total_price": 6268,169"total_price_set": {170"shop_money": {171"amount": "100",172"currency_code": "CLP"173},174"presentment_money": {175"amount": "100",176"currency_code": "CLP"177}178},179"total_price_usd": 7.82,180"total_shipping_price_set": {181"shop_money": {182"amount": "100",183"currency_code": "CLP"184},185"presentment_money": {186"amount": "100",187"currency_code": "CLP"188}189},190"total_tax": 19,191"total_tax_set": {192"shop_money": {193"amount": "100",194"currency_code": "CLP"195},196"presentment_money": {197"amount": "100",198"currency_code": "CLP"199}200},201"total_tip_received": 0,202"total_weight": 360,203"updated_at": "2022-03-11T18:48:58-05:00",204"user_id": 31522279,205"billing_address": {206"id": 7620158161121,207"customer_id": 6087092306145,208"first_name": "pruebas envio",209"last_name": "Chile",210"company": null,211"address1": "San Francisco 2511",212"address2": "Apartment 5",213"city": "San Miguel",214"province": "Santiago",215"country": "Chile",216"zip": "8320000",217"phone": "+(53)999888777",218"name": "pruebas envio Chile",219"latitude": -33.4777172,220"longitude": -70.6436693,221"country_code": "CL",222"province_code": "RM",223"country_name": "Chile",224"default": true225},226"customer": {227"id": 6087092306145,228"email": "test@shopping.com",229"accepts_marketing": false,230"created_at": "2022-02-21T09:31:56-05:00",231"updated_at": "2022-03-11T18:48:57-05:00",232"first_name": "pruebas envio",233"last_name": "Chile",234"orders_count": 5,235"state": "disabled",236"total_spent": 375.3,237"last_order_id": 234132602919,238"note": "Placed an order that had a fraud warning",239"verified_email": true,240"multipass_identifier": null,241"tax_exempt": false,242"phone": "555-625-1199",243"tags": "",244"last_order_name": "#1169",245"currency": "CLP",246"accepts_marketing_updated_at": "2022-02-21T09:31:56-05:00",247"tax_exemptions": [248"CA_STATUS_CARD_EXEMPTION",249"CA_BC_RESELLER_EXEMPTION"250],251"admin_graphql_api_id": "gid://shopify/Customer/6087092306145",252"default_address": {253"id": 7620158161121,254"customer_id": 6087092306145,255"first_name": "pruebas envio",256"last_name": "Chile",257"company": null,258"address1": "San Francisco 2511",259"address2": "Apartment 5",260"city": "San Miguel",261"province": "Santiago",262"country": "Chile",263"zip": "8320000",264"phone": "+(53)999888777",265"name": "pruebas envio Chile",266"latitude": -33.4777172,267"longitude": -70.6436693,268"country_code": "CL",269"province_code": "RM",270"country_name": "Chile",271"default": true272}273},274"discount_applications": [275{276"allocation_method": "across",277"code": "TENOFF",278"description": "customer deserved it",279"target_selection": "all",280"target_type": "shipping_line",281"title": "discount_code",282"type": "script",283"value": "10.0",284"value_type": "percentage"285}286],287"fulfillments": [288"466157049",289"466157078"290],291"line_items": [292{293"id": 12345,294"admin_graphql_api_id": "",295"destination_location": "",296"fulfillable_quantity": "",297"fulfillment_service": "",298"fulfillment_status": "",299"gift_card": "",300"grams": "800",301"name": "XXXXXXXXXX",302"origin_location": "",303"price": "400",304"price_set": "",305"product_exists": "",306"product_id": "xxxxxxxxxx",307"properties": "",308"quantity": "",309"requires_shipping": "true",310"sku": "",311"taxable": "true",312"title": "",313"total_discount": "",314"total_discount_set": "",315"variant_id": "xxxxxxxxxx",316"variant_inventory_management": "",317"variant_title": "",318"vendor": "XXXXXXXXXX",319"tax_lines": "",320"duties": "",321"discount_allocations": ""322}323],324"payment_terms": {325"amount": 70,326"currency": "CLP",327"payment_terms_name": "NET_30",328"payment_terms_type": "NET",329"due_in_days": 30,330"payment_schedules": [331{}332]333},334"refunds": [335{336"id": 18423447608,337"order_id": 394481795128,338"created_at": "2018-03-06T09:35:37-05:00",339"note": null,340"user_id": null,341"processed_at": "2018-03-06T09:35:37-05:00"342}343],344"shipping_address": {345"id": 7620158161121,346"customer_id": 6087092306145,347"first_name": "pruebas envio",348"last_name": "Chile",349"company": null,350"address1": "San Francisco 2511",351"address2": "Apartment 5",352"city": "San Miguel",353"province": "Santiago",354"country": "Chile",355"zip": "8320000",356"phone": "+(53)999888777",357"name": "pruebas envio Chile",358"latitude": -33.4777172,359"longitude": -70.6436693,360"country_code": "CL",361"province_code": "RM",362"country_name": "Chile",363"default": true364},365"shipping_lines": [366{367"id": 3908143841505,368"carrier_identifier": "2ef11aec7f5303b57bc02decab250d6d",369"code": "NEXT DAY",370"delivery_category": null,371"discounted_price": 614,372"discounted_price_set": {},373"phone": "999777004",374"price": 614,375"price_set": {},376"requested_fulfillment_service_id": "third_party_fulfillment_service_id",377"source": "Chazki",378"title": "CHAZKI - NEXT DAY",379"tax_lines": [380{}381],382"discount_allocations": [383{}384]385}386]387}