--- title: "Create an order that was prepared outside the Bolt ecosystem." method: POST path: "/orders" tags: ["Orders"] --- # Create an order that was prepared outside the Bolt ecosystem. `POST /orders` Create an order that was prepared outside the Bolt ecosystem. Some Bolt-powered flows automatically manage order creation - in those flows the order ID will be provided separately and not through this API. ## Headers - `X-Publishable-Key` string, required - `X-Merchant-Client-Id` string ## Request body - Order - `profile` Profile, required — An account's identifying information. - `first_name` string, required — The given name of the person associated with this profile. - `last_name` string, required — The last name of the person associated with this profile. - `email` string, email, required — The email address asscoiated with this profile. - `phone` string, phone — The phone number associated with this profile. - `cart` Cart, required - `order_reference` string, required — This value is used by Bolt as an external reference to a given order. This reference must be unique per successful transaction. - `order_description` string — Used optionally to pass additional information like order numbers or other IDs as needed. - `display_id` string — A shopper-facing identifier corresponding to the order reference associated with this transaction. - `shipments` CartShipment[] - `address` union - AddressReferenceId - `.tag` 'id', required — The type of address reference - `id` string, id, required — The address's ID - AddressReferenceExplicit - `.tag` 'explicit', required — The type of address reference - `id` string, id — The address's unique identifier. - `first_name` string, required — The first name of the person associated with this address. - `last_name` string, required — The last name of the person associated with this address. - `company` string — The company associated with this address. - `street_address1` string, required — The street address associated with this address. - `street_address2` string — Any additional, optional, street address information associated with this address. - `locality` string, required — The locality (e.g. city, town, etc...) associated with this address. - `postal_code` string, required — The postal code associated with this address. - `region` string — The region or administrative area (e.g. state, province, county, etc...) associated with this address. - `country_code` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BH' | 'BS' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required — The country (in its ISO 3166 alpha-2 format) associated with this address. - `email` string, email — The email address associated with this address. - `phone` string, phone — The phone number associated with this address. - AddressReferencePartial - `.tag` 'partial', required — The type of address reference - `postal_code` string, required — The postal code associated with the credit card billing address. - `cost` Amount — A monetary amount, i.e. a base unit amount and a supported currency. - `currency` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD', required — A supported currency. - `units` integer, required — A monetary amount, represented in its base units (e.g. USD/EUR cents). - `carrier` string — The name of the carrier selected. - `discounts` CartDiscount[] - `amount` Amount, required — A monetary amount, i.e. a base unit amount and a supported currency. - `currency` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD', required — A supported currency. - `units` integer, required — A monetary amount, represented in its base units (e.g. USD/EUR cents). - `code` string — Discount code. - `details_url` string, url — Used to provide a link to additional details, such as a landing page, associated with the discount offering. - `items` CartItem[] - `name` string, required — The name of a given item. - `reference` string, required — This value is used by Bolt as an external reference to a given item. - `description` string — A human-readable description of this cart item. - `seller_id` string — External reference ID for a marketplace seller. - `total_amount` Amount, required — A monetary amount, i.e. a base unit amount and a supported currency. - `currency` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD', required — A supported currency. - `units` integer, required — A monetary amount, represented in its base units (e.g. USD/EUR cents). - `unit_price` integer, required — The item's unit price, i.e. the cost of a single item exclusive of tax and discounts. - `quantity` integer, required — The number of units that comprise this cart item. - `image_url` string, url — Used to provide a link to the image associated with the item. - `subscription_plan_id` string — Subscription Plan ID that assigns this item to a specific subscription plan. - `total` Amount, required — A monetary amount, i.e. a base unit amount and a supported currency. - `currency` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD', required — A supported currency. - `units` integer, required — A monetary amount, represented in its base units (e.g. USD/EUR cents). - `tax` Amount, required — A monetary amount, i.e. a base unit amount and a supported currency. - `currency` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'USD', required — A supported currency. - `units` integer, required — A monetary amount, represented in its base units (e.g. USD/EUR cents). ## Response `200` The order was successfuly created - OrderResponse - `id` string, id, required - `transaction` Transaction, required - `reference` string - `authorizations` TransactionAuthorization[] — Payment authorization events attached to a transaction - `processor_reference` string - `processor_response` ProcessorResponse — Raw authorization response from the payment processor - `content_type` string - `api_version` string - `text` string ## Other responses - `4XX` — An error has occurred, and further details are contained in the response - `default` — An error has occurred, and no further details are provided (e.g. 5xx errors) --- [API](https://skmtc.net/bolt/apis/bolt-api-reference-2.md) · [All operations](https://skmtc.net/bolt/apis/bolt-api-reference-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bolt/bolt-api-reference-2/versions/1ed60fe3ec5c/schema)