Create Order

Direct order submission allows channels to submit fully composed orders, including their own tax and shipping calculations, in a single request to the merchant through Violet. This feature overrides the platform's built-in pricing engine, ensuring accuracy in the merchant's system of record and customer communications.

Learn more about Direct Order Submission in this guide.

The following information is required to be included in the Order payload of this request:

1. First Name

2. Last Name

3. Email

4. Shipping Address

5. Bag(s)

For a multi-merchant Order, multiple bags must be created in the Order payload. Each Bag must contain items from only one merchant and have its own shipping method.

When not bypassing payments, Violet currently only supports accepting Single-use Stripe Tokens as a payment method in this endpoint.

Submission Date

At the time of order submission a date_submitted property on the Order and Bag objects will be populated with ISO 8601 datetime values that reflect the submission time. On the Order object this value will capture the last time the Order was submitted to Violet. Each Bag object within the Order object will reflect the last time an attempt was made to submit the Bag to the external commerce platform.

Create Order

post

Creates and submits an order directly without the multi-step cart checkout flow (Direct Order Submission / DOS). Accepts a complete order payload including an optional payment method, customer information, one or more bags of SKUs, shipping and billing addresses, and optional line-item taxes and custom discounts. Validates inventory, pricing, and payment before creating the order on the merchant's commerce platform. All monetary values are in the smallest currency unit (e.g. cents for USD).

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Body

application/json

Request to create and submit an order in a single API call, bypassing the multi-step cart flow. Use this for direct order submission when you already have all order details (items, prices, shipping, taxes, payment). All monetary values are in the smallest currency unit (e.g. cents for USD).

Responses

200

success

application/json

A Violet Order representing a shopping cart that progresses through checkout to become a placed order. An Order contains one or more Bags (one per merchant), a customer, shipping/billing addresses, and a payment method. The lifecycle is: create cart → add items → set addresses → apply shipping → set payment → submit. All monetary values are in the smallest currency unit (e.g. cents for USD).

idinteger · int64Read-onlyRequired

ID of the Violet cart or order.

tokenstringRead-onlyOptionalDeprecated

An alternative UUID that can be used as an ID to reference the cart or order.

user_idinteger · int64Read-onlyOptionalDeprecated

ID of the User placing the order

app_idinteger · int32Read-onlyRequired

ID of the App responsible for the creation and submission of this Order.

developer_idinteger · int32Read-onlyRequired

ID of the Developer responsible for the creation and submission of this Order.

sub_totalinteger · int32Required

The price of the Order in the base currency before discounts, shipping, duties, taxes, and tips. In Cents.

Default: 0

shipping_totalinteger · int32Required

The sum of all shipping methods applied to the Order in the base currency. In Cents.

Default: 0

tax_totalinteger · int32Required

The sum of all the taxes applied to the Order in the base currency. In Cents.

Default: 0

discount_totalinteger · int32Required

The total discounts applied to the price of the Order in the base currency. In Cents.

Default: 0

totalinteger · int32Required

The sum of all item prices, discounts, shipping, and taxes applied to the Order in the base currency. In Cents.

Default: 0

app_customer_idstring · max: 191 · nullableOptional

App Customer ID. This should be used to map the order to the ID of the customer in your application.

app_order_idstring · max: 64 · nullableOptional

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.

statusstring · enumRead-onlyRequired

Status of the Order

Possible values:

is_guestbooleanRead-onlyRequired

Whether this is a guest checkout order. Guest orders do not create or link to a customer account in the merchant's system. Most orders placed via the Violet API are guest orders.

Default: true

date_createdstring · date-timeRead-onlyRequired

Date of order creation

date_last_modifiedstring · date-timeRead-onlyRequired

Indicates when the order was last modified. This timestamp is updated only when a property on the Order entity itself changes. Modifications to related entities (e.g., Bags) will not update this timestamp unless the change also triggers an update to the Order entity.

date_submittedstring · date-time · max: 24 · nullableRead-onlyOptional

Date the Order was last submitted in Violet. This value is captured immediately after the Order is successfully validated and before the nested Bag(s) are submitted to the external commerce platforms.

pricedbooleanRead-onlyRequired

Whether the cart has been priced. A cart must be priced before it can be submitted for checkout. Pricing is triggered automatically when shipping methods are applied and tax/shipping totals are calculated.

Default: false

wallet_based_checkoutbooleanRequired

Is this cart going to be placed through wallet-based checkout

Default: false

currencystring · min: 3 · max: 3Required

ISO 4217 currency code for the Order.

Default: USDExample: USD

referral_idstring · nullableOptional

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.

currency_symbolstringOptional

Symbol representing the currency the Order operates in.

app_namestringOptional

Name of app that originated the order. Use the "extended" query param when looking up orders to include this value.

stripe_keystringOptional

Stripe publishable key. Use for tokenizing payment methods.

payment_intent_client_secretstring · nullableRead-onlyOptional

Payment intent client secret. Use for payment intent based payment capture and external captures

order_idinteger · int64Optional

order_statusstring · enumOptionalPossible values:

guestbooleanOptional

intent_based_checkoutbooleanOptional

Boolean indicating if the cart/order will be payed using a payment intent.

400

bad request

application/json

401

unauthorized

application/json

404

not found

application/json

500

internal server error

application/json

post

/orders

HTTPcURLJavaScriptPython

POST /v1/orders HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 646

{
  "payment_method": {
    "type": "SINGLE_USE_CARD_TOKEN",
    "payment_provider": "STRIPE",
    "token": "tok_i1s2h8a9nyg1ukrju12h31kj212kh"
  },
  "order": {
    "app_order_id": "mario-test-1",
    "customer": {
      "first_name": "Ultra",
      "last_name": "Violet",
      "email": "[email protected]"
    },
    "bags": [
      {
        "skus": [
          {
            "sku_id": 80455,
            "price": 100000
          }
        ],
        "shipping_method": {
          "label": "Teleportation",
          "price": 10000
        },
        "tax_total": 10000
      }
    ],
    "shipping_address": {
      "address_1": "2815 Elliott Ave",
      "address_2": "Unit 100",
      "city": "Seattle",
      "state": "WA",
      "country": "US",
      "postal_code": "98121"
    },
    "billing_address": {
      "address_1": "200 West Street",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10282"
    },
    "currency": "USD"
  }
}

Minimal order with single SKUOrder with rate-based line item taxesOrder with amount-based line item taxesOrder with combined rate and amount taxesOrder with order-level percentage discountOrder with SKU-level fixed discountOrder with shipping-level discount (free shipping)Order with pre-authorized Stripe Payment IntentComplete example with all optional fields

{
  "id": 54609,
  "token": "f9bd116404dc4441838a94f31a942d5f",
  "errors": [],
  "app_id": 10193,
  "developer_id": 10122,
  "customer": {
    "first_name": "Ultra",
    "last_name": "Violet",
    "email": "[email protected]",
    "name": "Ultra Violet"
  },
  "bags": [
    {
      "id": 64579,
      "order_id": 54609,
      "merchant_id": 10064,
      "capture_status": "ACCEPTED",
      "fulfillment_status": "PROCESSING",
      "financial_status": "PAID",
      "skus": [
        {
          "id": 60509,
          "merchant_id": 10064,
          "app_id": 10193,
          "product_id": "815b064726de41d9a21de4bfc029416f",
          "sku_id": 80445,
          "external_id": "42519630413999",
          "name": "Lunar Lemonade - 10 oz.",
          "brand": "Space Drinks",
          "thumbnail": "https://cdn.shopify.com/s/files/1/0621/1849/4383/files/wealthy_lunar_lemonade_4a9c0731-8758-4847-91e1-d6d37d6ace22.png",
          "quantity": 1,
          "price": 100000,
          "weight": 3,
          "available": true,
          "capture_status": "PROCESSING",
          "product_type": "PHYSICAL",
          "line_price": 100000
        }
      ],
      "shipping_method": {
        "type": "FLAT_RATE_PRICE",
        "carrier": "OTHER",
        "label": "Teleportation",
        "price": 10000,
        "custom": false,
        "id": 21839,
        "merchant_id": 10064
      },
      "taxes": [
        {
          "order_id": 54609,
          "merchant_id": 10064,
          "state": "WA",
          "rate": 10,
          "amount": 10000
        }
      ],
      "sub_total": 100000,
      "shipping_total": 10000,
      "tax_total": 10000,
      "total": 120000,
      "taxes_included": false,
      "transactions": [],
      "external_checkout": false,
      "commission_rate": 0,
      "date_created": "2024-06-28T20:31:56+0000",
      "date_last_modified": "2024-06-28T20:31:56.000+00:00",
      "remorse_period_ends": "2024-07-28T20:31:56+0000",
      "currency": "USD",
      "external_currency": "USD",
      "channel": "MARKETPLACE",
      "app_order_id": "ishan-test-1",
      "platform": "SHOPIFY",
      "fulfillments": [],
      "discounts": [],
      "wallet_based_checkout": false,
      "bag_id": 64579,
      "bag_status": "ACCEPTED",
      "merchant_name": "Space Drinks"
    }
  ],
  "shipping_address": {
    "name": "Ultra Violet",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "type": "BILLING",
    "address_1": "2815 Elliott Ave",
    "address_2": "Unit 100",
    "first_name": "Ultra",
    "last_name": "Violet"
  },
  "billing_address": {
    "name": "Ultra Violet",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postal_code": "10282",
    "type": "BILLING",
    "address_1": "200 West Street",
    "first_name": "Ultra",
    "last_name": "Violet"
  },
  "payment_transactions": [
    {
      "id": 31464,
      "order_id": 54627,
      "payment_provider": "STRIPE",
      "payment_provider_transaction_id": "pi_3PXoWvK29KDiBVld1n7ym4B0",
      "payment_method_id": 10630,
      "payment_provider_payment_method_id": "pm_1PXoWvK29KDiBVldLNqe04Oi",
      "payment_intent_client_secret": "pi_3PXoWvK29KDiBVld1n7ym4B0_secret_tB77zb3BoTCKigUe5R38hrCKS",
      "amount": 120000,
      "metadata": {
        "payment_intent_client_secret": "pi_3PXoWvK29KDiBVld1n7ym4B0_secret_tB77zb3BoTCKigUe5R38hrCKS",
        "payment_intent_id": "pi_3PXoWvK29KDiBVld1n7ym4B0"
      },
      "currency": "USD",
      "capture_status": "CAPTURED",
      "errors": [],
      "date_created": "2024-07-01T18:00:45+0000",
      "date_last_modified": "2024-07-01T18:00:48+0000"
    }
  ],
  "sub_total": 0,
  "shipping_total": 0,
  "tax_total": 0,
  "total": 0,
  "app_order_id": "mario-test-1",
  "capture_status": "COMPLETED",
  "is_guest": true,
  "date_created": "2024-06-28T20:31:56+0000",
  "date_last_modified": "2024-06-28T20:31:56+0000",
  "priced": true,
  "wallet_based_checkout": false,
  "currency": "USD",
  "channel": "MARKETPLACE",
  "currency_symbol": "$",
  "intent_based_checkout": true,
  "order_status": "COMPLETED",
  "order_id": 54609,
  "guest": true
}