- Get API Keys
- Welcome
Access
Offers
SKUs
Categories
Collections
Currencies
Cart
Payment
Customer
Completion
Shipping
Discounts
Items
Refunds
Orders
Merchant
Configuration
Explore
Webhooks
Webhook Events
Wekbhook Headers
Merchant/App Installs
Connection
Shipping
Overview
Login
Catalog
Orders & Checkout
Merchants
Events
Apps
Operations
Relay
Create Cart
Optional data to initialize the cart with on creation.
Base currency of cart
Optional collection of SKUs
Associate the order with a user or affiliate in your system
Map the order in Violet to an order record within your system
The Customer Placing the Order
ID of the User the Order Customer references
First Name
Last Name
Email Address of Customer
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
Email Address
First line of the Address
Second line of the Address
Use Same Address for Both
Optional collection of Discounts
Boolean denoting whether or not this order will be placed through a wallet based payment mechanism such as apple pay
curl --request POST \
--url https://sandbox-api.violet.io/v1/checkout/cart \
--header 'Content-Type: application/json' \
--data '{
"base_currency": "USD",
"skus": [
{
"sku_id": 12345,
"quantity": 1
}
],
"customer": {
"email": "p.sherman@findingnemo.com",
"first_name": "P",
"last_name": "Sherman",
"shipping_address": {
"address_1": "42 Wallaby Way",
"city": "Sydney",
"country": "AU",
"postal_code": 4000,
"state": "NSW",
"type": "SHIPPING",
"phone": 1234567890
},
"same_address": true
}
}'{
"id": 123,
"token": "<string>",
"errors": [
{
"id": 123,
"order_id": 123,
"bag_id": 123,
"entity_id": "<string>",
"type": "EXTERNAL_CREATE_CART",
"message": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"platform": "OTHER"
}
],
"user_id": 123,
"app_id": 123,
"developer_id": 123,
"customer": {
"user_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"external_id": "<string>",
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"same_address": true,
"name": "<string>"
},
"bags": [
{
"id": 123,
"order_id": 123,
"merchant_id": 123,
"app_id": 123,
"external_id": "<string>",
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"skus": [
{
"id": 123,
"merchant_id": 123,
"app_id": 123,
"product_id": "<string>",
"sku_id": 123,
"external_id": "<string>",
"name": "<string>",
"brand": "<string>",
"thumbnail": "<string>",
"quantity": 123,
"price": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"available": true,
"status": "IN_PROGRESS",
"product_type": "PHYSICAL",
"custom": true,
"custom_properties": [
{
"name": "engraving",
"value": "Happy Birthday!"
}
],
"quantity_fulfilled": 123,
"order_sku_rates": [
{
"order_sku_id": 123,
"amount": 123,
"rate": 123,
"type": "TAX",
"name": "<string>",
"decimal_rate": 123,
"dollar_amount": 123
}
],
"line_price": 123
}
],
"shipping_method": {
"type": "CALCULATED",
"Carrier": "OTHER",
"label": "<string>",
"price": 123,
"custom": true,
"min_subtotal": 123,
"max_subtotal": 123,
"min_weight": 123,
"max_weight": 123,
"external_id": "<string>",
"id": 123,
"shipping_method_id": "<string>",
"bag_id": 123,
"merchant_id": 123,
"tracking_number": "<string>"
},
"taxes": [
{
"order_id": 123,
"merchant_id": 123,
"skus": [
"<string>"
],
"state": "<string>",
"postal_code": "<string>",
"rate": 123,
"amount": 123,
"description": "<string>"
}
],
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"taxes_included": true,
"transactions": [
{
"id": 123,
"merchant_id": 123,
"app_id": 123,
"order_id": 123,
"bag_id": 123,
"payment_method_id": 123,
"gateway_transaction_id": "<string>",
"gateway": "<string>",
"amount": 123,
"currency": "<string>",
"type": "AUTHORIZATION",
"error_code": "<string>",
"status": "PROCESSING",
"test": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"order_payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
}
}
],
"external_checkout": true,
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"remorse_period_ends": "2023-11-07T05:31:56Z",
"currency": "<string>",
"external_currency": "<string>",
"currency_exchange_rate": 123,
"channel": "APP",
"app_order_id": "<string>",
"platform": "OTHER",
"fulfillments": [
{
"id": 123,
"bag_id": 123,
"external_id": "<string>",
"carrier": "OTHER",
"raw_carrier": "<string>",
"status": "PENDING",
"carrier_status": "PENDING",
"tracking_number": "<string>",
"tracking_url": "<string>",
"skus": [
{
"id": 123,
"fulfillment_id": 123,
"order_sku_id": 123,
"quantity_fulfilled": 123
}
]
}
],
"discounts": [
{
"id": 123,
"bag_id": 123,
"status": "PENDING",
"type": "CODE",
"value_type": "AMOUNT",
"target_type": "ORDER",
"code": "<string>",
"external_id": "<string>",
"amount": 123,
"percentage": 123,
"amount_total": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z"
}
],
"wallet_based_checkout": true,
"app_name": "<string>",
"bag_id": 123,
"bag_status": "IN_PROGRESS",
"merchant_name": "<string>"
}
],
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
},
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"app_customer_id": "<string>",
"app_order_id": "<string>",
"status": "IN_PROGRESS",
"is_guest": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"priced": true,
"wallet_based_checkout": true,
"currency": "<string>",
"referral_id": "<string>",
"currency_symbol": "<string>",
"app_name": "<string>",
"stripe_key": "<string>",
"payment_intent_client_secret": "<string>",
"order_id": 123,
"guest": true,
"order_status": "IN_PROGRESS",
"intent_based_checkout": true
}Create a Cart in Violet. Violet will create carts in any underlying E-Commerce platforms in parallel.
Carts are dynamic in Violet. Not all fields my be populated at any given point in time. If there are any issues during the Checkout process, errors will be present in the errors field on the Cart.
Headers
Query Parameters
APP, MARKETPLACE, FACEBOOK, INSTAGRAM, WALMART, GOOGLE, TIKTOK, SNAPCHAT, PINTEREST Body
Base currency of cart
Optional collection of SKUs
ID of the Merchant the SKU belongs to
ID of the App creating the Order
ID of the Product
ID of the referenced SKU
ID of the SKU on the External Ecommerce Platform
Name of the SKU
Brand Name
URL of the thumbnail image. Useful for order overview displays
Quantity of the SKU being purchased. Quantities over 1000 will default to 1000
Price of the individual SKU. In Cents
Weight of SKU
Height of SKU
Width of SKU
Length of SKU
Is the product still available for purchase. If a SKU becomes unavailable it likely means that the product became out of stock after it was added to the cart. Unavailable SKUs cannot be purchased.
Sku Status
IN_PROGRESS, PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED, CANCELED, REFUNDED, ERROR, PARTIALLY_RETURNED, PARTIALLY_REFUNDED Product Type
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED Is the Sku custom. True when the price has been overridden.
Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.
Name of the custom property.
Value of the custom property.
The quantity of this item that has been fulfilled
ID of the Order SKU the Rate belongs to
Total Tax amount on Bag. In Cents
Rate
Rate Type
TAX, SHIPPING, FEE, DUTY Rate Name
Price of the SKU multiplied by the Quantity. In Cents
Associate the order with a user or affiliate in your system
Map the order in Violet to an order record within your system
The Customer Placing the Order
ID of the User the Order Customer references
First Name
Last Name
Email Address of Customer
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
Use Same Address for Both
Optional collection of Discounts
Discount code being applied
ID of the Merchant the discount belongs to
Boolean denoting whether or not this order will be placed through a wallet based payment mechanism such as apple pay
Response
Errors on the Order. During checkout, if there was an error or issue on one of the order's bags, there will be an error added to this list describing the issue. The checkout API will return 200 with the order object in the response even if there was an issue with a bag so you must always check the response for errors in this list to know if there was an issue on the order.
Order ID
Bag ID
Entity ID
Error Type
EXTERNAL_CREATE_CART, EXTERNAL_ADD_ITEM, EXTERNAL_UPDATE_ITEM, EXTERNAL_REMOVE_ITEM, EXTERNAL_ADD_CUSTOMER, EXTERNAL_ADD_ADDRESSES, EXTERNAL_ADD_SHIPPING_ADDRESS, EXTERNAL_ADD_BILLING_ADDRESS, EXTERNAL_GET_SHIPPING_METHODS, EXTERNAL_SET_SHIPPING_METHOD, EXTERNAL_SET_PAYMENT_METHOD, EXTERNAL_PRICE_CART, EXTERNAL_SUBMIT_CART, INTERNAL_ADD_ITEM, EXTERNAL_DELETE_CART, EXTERNAL_CANCEL_ORDER, EXTERNAL_WRITE_ORDER, EXTERNAL_MARK_ORDER_AS_PAID, EXTERNAL_ADD_DISCOUNT_CODE, EXTERNAL_REMOVE_DISCOUNT_CODE, EXTERNAL_DELETE_ORDER Error Message
Date of creation
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM ID of the User placing the order
ID of the App creating the order
ID of the Developer who placed
The Customer Placing the Order
ID of the User the Order Customer references
First Name
Last Name
Email Address of Customer
ID of the Customer on the External Platform
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
Use Same Address for Both
Bags in the Order
ID of the Order the Bag belongs to
ID of the Merchant the Bag references
ID of the App creating this Bag
ID of the Order on the External Ecommerce Platform
Status
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Fulfillment Status
PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED Financial Status
UNPAID, AUTHORIZED, PENDING, PAID, PARTIALLY_PAID, REFUNDED, PARTIALLY_REFUNDED, VOIDED SKUs added to the bag
ID of the Merchant the SKU belongs to
ID of the App creating the Order
ID of the Product
ID of the referenced SKU
ID of the SKU on the External Ecommerce Platform
Name of the SKU
Brand Name
URL of the thumbnail image. Useful for order overview displays
Quantity of the SKU being purchased. Quantities over 1000 will default to 1000
Price of the individual SKU. In Cents
Weight of SKU
Height of SKU
Width of SKU
Length of SKU
Is the product still available for purchase. If a SKU becomes unavailable it likely means that the product became out of stock after it was added to the cart. Unavailable SKUs cannot be purchased.
Sku Status
IN_PROGRESS, PROCESSING, SHIPPED, PARTIALLY_SHIPPED, DELIVERED, COULD_NOT_DELIVER, RETURNED, CANCELED, REFUNDED, ERROR, PARTIALLY_RETURNED, PARTIALLY_REFUNDED Product Type
PHYSICAL, DIGITAL, VIRTUAL, BUNDLED Is the Sku custom. True when the price has been overridden.
Used to provide the merchant with custom values for the product. This functionality is currently limited to Shopify merchants.
Name of the custom property.
Value of the custom property.
The quantity of this item that has been fulfilled
ID of the Order SKU the Rate belongs to
Total Tax amount on Bag. In Cents
Rate
Rate Type
TAX, SHIPPING, FEE, DUTY Rate Name
Price of the SKU multiplied by the Quantity. In Cents
Shipping Methods belonging to an Order
Type of Shipping Method
CALCULATED, FLAT_RATE_PRICE, FLAT_RATE_WEIGHT OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Shipping Method Label
Total cost of the Shipping Method. In Cents
Is the shipping method custom. True when the price has been overridden.
Minimum Subtotal. In Cents. Only applies to Flat Rate by Price
Maximum Subtotal. In Cents. Only applies to Flat Rate by Price
Minimum Weight. In Cents. Only applies to Flat Rate by Weight
Maximum Weight. In Cents. Only applies to Flat Rate by Weight
ID(s) on external ecommerce platform
ID of the referenced Shipping Method
ID of the Bag the Shipping Method applies to
ID of the merchant the bag belongs to
Carrier Tracking Number
Taxes applied to the bag
ID of the Order the Tax belongs to
ID of the Merchant the Bag belongs to
SKUs covered by the Tax
State abbreviation
Postal/Zip Code
Tax Rate
Total Tax amount on Bag. In Cents
Description of the Tax
The price of the Bag in the base currency before discounts, shipping, duties, taxes, and tips. In Cents
The sum of all shipping methods applied to the Bag in the base currency. In Cents
The sum of all the taxes applied to the Bag in the base currency. In Cents
The total discounts applied to the price of the Bag in the base currency. In Cents
The sum of all item prices, discounts, shipping, and taxes applied to the Bag in the base currency. In Cents
Are taxes included in the cart total.
Transactions of the bag
ID of the Merchant receiving the transaction
ID of the App that created the Order
ID of the Order the Transaction applies to
ID of the Bag the Transaction applies to
ID of the referenced Payment Method
ID of the Transaction in the Payment Gateway
Gateway processing the Transaction
Total amount being transacted
Currency the Transaction takes place in
Transaction Type
AUTHORIZATION, CAPTURE, SALE, VOID, REFUND Error Code from gateway if error occurred
Transaction Status
PROCESSING, COMPLETED, REFUNDED, REQUIRES_ACTION Is this a test Transaction
Date of transaction creation
Date of last transaction update
Payment Method belonging to an Order
Brand of Card
Last Four Numbers on Card
Card Expiration Month
Card Expiration Year
Name as it appears on Card
ID of the referenced Payment Method
Is Default Method
If bag is tracked externally
The developer commission rate
Date of creation
Date of last update
Date of last consolidation
Date when the bag can no longer be refunded
Base currency of cart
Currency of cart on external ecommerce platform
Exchange rate of currency and external currency, if different, at the time the bag was last priced.
The channel that originated this order.
APP, MARKETPLACE, FACEBOOK, INSTAGRAM, WALMART, GOOGLE, TIKTOK, SNAPCHAT, PINTEREST App Order ID. Automatically obtained through the app_order_id applied to the order.
The commerce platform used by this merchant.
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM ID of the bag the fulfillment belongs to.
ID of the fulfillment on the external commerce platform.
Carrier responsible for the fulfillment. Will be OTHER if raw carrier is not recognized.
OTHER, UPS, USPS, FEDEX, DHL, ONTRAC, ROYAL_MAIL, SENDLE, POSTNORD Raw name of carrier from the external commerce platform.
ID of the Bag the fulfillment belongs to.
PENDING, PROCESSING, SUCCESS, CANCELED, ERROR, FAILURE, NONE_PROVIDED ID of the Bag the fulfillment belongs to.
PENDING, LABEL_PURCHASED, LABEL_PRINTED, CONFIRMED, READY_FOR_PICKUP, IN_TRANSIT, OUT_FOR_DELIVERY, ATTEMPTED_DELIVERY, DELIVERED, FAILURE, NONE_PROVIDED Tracking number provider by the carrier.
Tracking URL provider by the carrier.
SKUs fulfilled by this fulfillment.
ID of the fulfillment that contains this item.
ID of the SKU in the Bag.
Quantity of the this item fulfilled by this fulfillment.
ID of the Bag this discount belong to
Status of discount
PENDING, APPLIED, INVALID, NOT_SUPPORTED, ERROR, EXPIRED Type of discount
CODE Value type of discount
AMOUNT, PERCENTAGE Target type of the discount
ORDER, SKU, SHIPPING Code of discount
External ID of discount
Amount of discount
Percentage of discount
Total amount of discount applied to bag
Date of creation
Date of last bag discount update
Is this bag going to be placed through wallet-based checkout
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
IN_PROGRESS, SUBMITTED, ACCEPTED, COMPLETED, PARTIALLY_REFUNDED, REFUNDED, REJECTED, CANCELED, BACKORDERED Name of Merchant
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
The shipping or billing address of a user placing an order
Name on Address
City
State Abbreviation
Country ISO2 Code
Postal/Zip Code
Phone Number
Address Type
SHIPPING, BILLING Email Address
First line of the Address
Second line of the Address
Payment Method belonging to an Order
Brand of Card
Last Four Numbers on Card
Card Expiration Month
Card Expiration Year
Name as it appears on Card
ID of the referenced Payment Method
Is Default Method
The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.
The sum of all shipping methods applied to the Order in the base currency. In Cents.
The sum of all the taxes applied to the Order in the base currency. In Cents.
The total discounts applied to the price of the Order in the base currency. In Cents.
The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.
App Customer ID. This should be used to map the order to the ID of the customer in your application.
App Order ID. This should be set to a unique identifier in your system. While not enforced unique in Violet's system, it is strongly recommended that unique values are used for each cart to help correlate identifiers between Violet's system and yours.
Status of the Order
IN_PROGRESS, PROCESSING, COMPLETED, CANCELED, PARTIALLY_REFUNDED, REFUNDED, REQUIRES_ACTION Order is Guest
Date of order creation
Date of last order update
Is the cart priced
Is this cart going to be placed through wallet-based checkout
Base currency of cart
Optional value used to represent an identifier in your system. This value is not required to represent a referral. It can represent the ID of anything in your system and can be used to filter order lookup results. Max length of 128 characters.
Symbol representing the desired currency
Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.
Stripe publishable key. Use for tokenizing payment methods.
Payment intent client secret. Use for payment intent based payment capture and external captures
IN_PROGRESS, PROCESSING, COMPLETED, CANCELED, PARTIALLY_REFUNDED, REFUNDED, REQUIRES_ACTION Boolean indicating if the cart/order will be payed using a payment intent.
Was this page helpful?
curl --request POST \
--url https://sandbox-api.violet.io/v1/checkout/cart \
--header 'Content-Type: application/json' \
--data '{
"base_currency": "USD",
"skus": [
{
"sku_id": 12345,
"quantity": 1
}
],
"customer": {
"email": "p.sherman@findingnemo.com",
"first_name": "P",
"last_name": "Sherman",
"shipping_address": {
"address_1": "42 Wallaby Way",
"city": "Sydney",
"country": "AU",
"postal_code": 4000,
"state": "NSW",
"type": "SHIPPING",
"phone": 1234567890
},
"same_address": true
}
}'{
"id": 123,
"token": "<string>",
"errors": [
{
"id": 123,
"order_id": 123,
"bag_id": 123,
"entity_id": "<string>",
"type": "EXTERNAL_CREATE_CART",
"message": "<string>",
"date_created": "2023-11-07T05:31:56Z",
"platform": "OTHER"
}
],
"user_id": 123,
"app_id": 123,
"developer_id": 123,
"customer": {
"user_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"external_id": "<string>",
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"same_address": true,
"name": "<string>"
},
"bags": [
{
"id": 123,
"order_id": 123,
"merchant_id": 123,
"app_id": 123,
"external_id": "<string>",
"status": "IN_PROGRESS",
"fulfillment_status": "PROCESSING",
"financial_status": "UNPAID",
"skus": [
{
"id": 123,
"merchant_id": 123,
"app_id": 123,
"product_id": "<string>",
"sku_id": 123,
"external_id": "<string>",
"name": "<string>",
"brand": "<string>",
"thumbnail": "<string>",
"quantity": 123,
"price": 123,
"weight": 123,
"height": 123,
"width": 123,
"length": 123,
"available": true,
"status": "IN_PROGRESS",
"product_type": "PHYSICAL",
"custom": true,
"custom_properties": [
{
"name": "engraving",
"value": "Happy Birthday!"
}
],
"quantity_fulfilled": 123,
"order_sku_rates": [
{
"order_sku_id": 123,
"amount": 123,
"rate": 123,
"type": "TAX",
"name": "<string>",
"decimal_rate": 123,
"dollar_amount": 123
}
],
"line_price": 123
}
],
"shipping_method": {
"type": "CALCULATED",
"Carrier": "OTHER",
"label": "<string>",
"price": 123,
"custom": true,
"min_subtotal": 123,
"max_subtotal": 123,
"min_weight": 123,
"max_weight": 123,
"external_id": "<string>",
"id": 123,
"shipping_method_id": "<string>",
"bag_id": 123,
"merchant_id": 123,
"tracking_number": "<string>"
},
"taxes": [
{
"order_id": 123,
"merchant_id": 123,
"skus": [
"<string>"
],
"state": "<string>",
"postal_code": "<string>",
"rate": 123,
"amount": 123,
"description": "<string>"
}
],
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"taxes_included": true,
"transactions": [
{
"id": 123,
"merchant_id": 123,
"app_id": 123,
"order_id": 123,
"bag_id": 123,
"payment_method_id": 123,
"gateway_transaction_id": "<string>",
"gateway": "<string>",
"amount": 123,
"currency": "<string>",
"type": "AUTHORIZATION",
"error_code": "<string>",
"status": "PROCESSING",
"test": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"order_payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
}
}
],
"external_checkout": true,
"commission_rate": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"date_last_consolidated": "2023-11-07T05:31:56Z",
"remorse_period_ends": "2023-11-07T05:31:56Z",
"currency": "<string>",
"external_currency": "<string>",
"currency_exchange_rate": 123,
"channel": "APP",
"app_order_id": "<string>",
"platform": "OTHER",
"fulfillments": [
{
"id": 123,
"bag_id": 123,
"external_id": "<string>",
"carrier": "OTHER",
"raw_carrier": "<string>",
"status": "PENDING",
"carrier_status": "PENDING",
"tracking_number": "<string>",
"tracking_url": "<string>",
"skus": [
{
"id": 123,
"fulfillment_id": 123,
"order_sku_id": 123,
"quantity_fulfilled": 123
}
]
}
],
"discounts": [
{
"id": 123,
"bag_id": 123,
"status": "PENDING",
"type": "CODE",
"value_type": "AMOUNT",
"target_type": "ORDER",
"code": "<string>",
"external_id": "<string>",
"amount": 123,
"percentage": 123,
"amount_total": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z"
}
],
"wallet_based_checkout": true,
"app_name": "<string>",
"bag_id": 123,
"bag_status": "IN_PROGRESS",
"merchant_name": "<string>"
}
],
"shipping_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"billing_address": {
"name": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"type": "SHIPPING",
"email": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"payment_method": {
"brand": "<string>",
"last_four": "<string>",
"exp_month": 123,
"exp_year": 123,
"cardholder_name": "<string>",
"payment_method_id": 123,
"default": true
},
"sub_total": 123,
"shipping_total": 123,
"tax_total": 123,
"discount_total": 123,
"total": 123,
"app_customer_id": "<string>",
"app_order_id": "<string>",
"status": "IN_PROGRESS",
"is_guest": true,
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"priced": true,
"wallet_based_checkout": true,
"currency": "<string>",
"referral_id": "<string>",
"currency_symbol": "<string>",
"app_name": "<string>",
"stripe_key": "<string>",
"payment_intent_client_secret": "<string>",
"order_id": 123,
"guest": true,
"order_status": "IN_PROGRESS",
"intent_based_checkout": true
}