Allow variables list
Field name | Notes | Example |
id | Shopify internal order ID | 450789469 |
name | Shopify order name | #10001 |
note | The value of the special instructions / notes field | |
delivery.customer.name | Andrew Cargill | |
delivery.customer.first_name | The first name of the person associated with the delivery address. | Andrew |
delivery.customer.last_name | The last name of the person associated with the delivery address. | Cargill |
delivery.address.company_name | The company of the person associated with the delivery address. | |
delivery.address.address_line_1 | The street address of the delivery address. | |
delivery.address.address_line_2 | An optional additional field for the street address of the delivery address. | |
delivery.address.city | The city, town, or village of the delivery address. | |
delivery.address.country | The name of the country of the delivery address. | |
delivery.address.region | The name of the region (province, state, prefecture, …) of the delivery address. | |
delivery.address.postal_code | The postal code (zip, postcode, Eircode, …) of the delivery address. | |
delivery.address.phone | The phone number at the delivery address. | |
delivery.address.latitude | The latitude of the delivery address. | |
delivery.address.longitude | The longitude of the delivery address. | |
delivery.address.country_code | The two-letter code (ISO 3166-1 format) for the country of the delivery address. | |
delivery.address.region_code | The two-letter abbreviation of the region of the delivery address. | |
delivery.datetime | The date and time the customer selected to receive their order. ISO 8601 format. | 2020-07-17T12:30:00+00:00 |
delivery.start_datetime | The earliest date and time the customer selected to receive their order. ISO 8601 format. | 2020-07-17T12:30:00+00:00 |
delivery.end_datetime | The latest date and time the customer selected to receive their order. ISO 8601 format. | 2020-07-17T13:00:00+00:00 |
delivery.note | The variable for our delivery notes feature. |
Pickup details
Field name | Notes | Example |
pickup.address.company_name | The company of the person associated with the delivery address. | Apple |
pickup.address.address_line_1 | The street address of the delivery address. | 767 5th Ave |
pickup.address.address_line_2 | An optional additional field for the street address of the delivery address. | |
pickup.address.city | The city, town, or village of the delivery address. | New York |
pickup.address.country | The name of the country of the delivery address. | United States |
pickup.address.country_code | The two-letter code (ISO 3166-1 format) for the country of the delivery address. | US |
pickup.address.region | The name of the region (province, state, prefecture, …) of the delivery address. | New York |
pickup.address.postal_code | The postal code (zip, postcode, Eircode, …) of the delivery address. | 10153 |
pickup.address.region_code | The two-letter abbreviation of the region of the delivery address. | NY |
pickup.address.latitude | Latitude of pickup location | 53.3736828 |
pickup.address.longitude | Longitude of pickup location | -0.0160712 |
pickup.datetime | The date and time the order should be collected from the merchant. ISO 8601 format | 2020-07-17T12:15:00+00:00 |
pickup.date | YYYY-MM-DD | 2020-06-22 |
pickup.time | HH:MM | 12:30 |
pickup.address.custom_attributes_1 | ||
pickup.address.custom_attributes_2 | ||
pickup.address.custom_attributes_3 |
Items
Field name | Notes | Example |
id | The ID of the item. | 669751112 |
price | The price of the item before discounts have been applied in the shop currency. | 199.99 |
grams | The weight of the item in grams. | 500 |
quantity | The number of items that were purchased. | 5 |
product_id | The ID of the product that the line item belongs to. Can be null if the original product associated with the order is deleted at a later date. | 7513685 |
sku | The item's SKU (stock keeping unit). | IPod-342-n |
title | The title of the product. | iPod Nano |
variant_id | The ID of the product variant. | 4264112 |
variant_title | The title of the product variant. | Pink |
vendor | The name of the item's supplier. | Apple |
name | The name of the product variant. | iPod Nano - Pink |
Settings
Field name | Notes | Example |
settings.signature_required | true | |
settings.min_age | 21 | |
settings.notifications_enabled | false | |
settings.courier_rates_enabled | Whether the merchants want to use dynamically generated rates or manually configure | true |
Courier
Field name | Notes | Example |
courier.delivery.id | The last mile couriers unique identifier for the delivery | 100001 |
Last updated