Order
Create POS order
Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
- Overview
- PATCHCancel order
- POSTSync order status
- PATCHReturn order
- GETGet order by user
- POSTReturn payment by orderId
- POSTCancel order by user
- POSTAdd shipment bulk to order
- GETGet order
- POSTOrder query
- POSTBulk cancel orders
- POSTBulk return orders
- POSTCreate POS order
- GETGet order by email
- POSTReturn order by user
- POSTOrder checkout
- POSTAdd shipment to order
- POSTCreate subscriptions orders
- POSTOrder checkout (v4)
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Order
Create POS order
Create POS order
POST
/
api-order
/
pos
/
orders
curl --request POST \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/pos/orders \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '{
"channel": 12,
"orderReference": 1234,
"locationId": "5efcc26a5ee50d00079ca2ab",
"orderTotal": 125.33,
"taxTotal": 5.23,
"orderCurrency": "USD",
"status": "ORDER_CREATED",
"statusLog": "Order has been Shipped",
"customerUserId": "5e3598e3007c5e00080d2bb8",
"customerAccountId": "5e3598e3007c5e00080d2bb8",
"customerEmail": "ino@fabric.inc",
"customerPhone": {
"number": "555-555-5555",
"kind": "mobile"
},
"shipTo": [
{
"shipToId": 1000001,
"shipToType": "SHIP_TO_ADDRESS",
"address": {
"name": {
"first": "Mark",
"middle": "p",
"last": "styler"
},
"email": "mark@google.com",
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"price": 24.8723423,
"currency": "USD",
"estimatedTax": 10,
"committedTax": 10,
"promosApplied": [
{
"name": "test1"
}
],
"total": 34.87,
"taxCode": "FR020000",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Express",
"shipmentMethodId": 10000001,
"promisedDeliveryDate": "2021-02-14",
"shipmentInstructions": "Leave at back door",
"shipmentStatus": "Delivered",
"items": [
{
"lineItemId": 1,
"itemId": 1000011127,
"sku": 1538910,
"group": [
"Group1"
],
"title": "Luminous Cushion Lagoon",
"quantity": 10,
"price": 4.5,
"discount": 1,
"currency": "USD",
"shipToId": 1000001,
"estimatedTax": 10.25,
"committedTax": 10.25,
"promosApplied": [
{
"name": "test"
}
],
"total": 4.54234234,
"taxCode": "FR020000",
"weight": 10,
"weightUnit": "lb"
}
],
"shipments": [
"<any>"
],
"payments": [
{
"billToId": 1000001,
"shipToId": [
1000001
],
"paymentIdentifier": {
"cardIdentifier": 4242
},
"paymentMethod": "Visa",
"paymentToken": {
"token": 12345689
},
"paymentKind": "Default payment",
"amount": 533.33,
"currency": "USD",
"conversion": 1,
"paymentStatus": "Pending",
"billToAddress": {
"name": {
"first": "Marl",
"middle": "p",
"last": "styler"
},
"email": "mark@google.com",
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
}
}
]
}
]
}'{
"tags": [
"<any>"
],
"_id": "60944ade71cdfc0008a621a2",
"channel": 12,
"orderReference": "testorder",
"orderTotal": 125.33,
"taxTotal": 5.23,
"orderCurrency": "USD",
"status": "ORDER_CREATED",
"statusLog": "Order has been created",
"customerUserId": "5e3598e3007c5e00080d2bb8",
"customerAccountId": "5e3598e3007c5e00080d2bb8",
"customerEmail": "ino@fabric.inc",
"customerPhone": {
"number": "555-555-5555",
"kind": "mobile"
},
"orderId": "7998-1161-63560",
"shipTo": [
{
"address": {
"name": {
"first": "Mark",
"middle": "p",
"last": "styler"
},
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"email": "mark@google.com",
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"promosApplied": [
{
"name": "test1"
}
],
"_id": "60944ade71cdfc0008a621a3",
"shipToId": 1000001,
"shipToType": "SHIP_TO_ADDRESS",
"price": 24.87,
"currency": "USD",
"estimatedTax": 10,
"committedTax": 10,
"total": 34.87,
"taxCode": "FR020000",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Express",
"shipmentMethodId": 10000001,
"promisedDeliveryDate": "2021-02-14T00:00:00.000Z",
"shipmentInstructions": "Leave at back door",
"shipmentStatus": "Delivered"
}
],
"items": [
{
"group": [
"Group1"
],
"promosApplied": [
{
"name": "test"
}
],
"_id": "60944ade71cdfc0008a621a4",
"lineItemId": 1,
"itemId": 1000000051,
"priceListId": 100003,
"sku": 1538910,
"title": "Luminous Cushion Lagoon",
"quantity": 10,
"price": 4.5,
"discount": 1,
"currency": "USD",
"shipToId": 1000001,
"estimatedTax": 10.25,
"committedTax": 10.25,
"total": 4.54,
"taxCode": "FR020000",
"weight": 10,
"weightUnit": "lb",
"reservedLocation": [
"<any>"
],
"attributes": [
"<any>"
]
}
],
"shipments": [
"<any>"
],
"payments": [
{
"billToAddress": {
"name": {
"first": "Marl",
"middle": "p",
"last": "styler"
},
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"email": "mark@google.com",
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"shipToId": [
1000001
],
"_id": "60944ade71cdfc0008a621a5",
"billToId": 1000001,
"paymentIdentifier": {
"cardIdentifier": 4242
},
"paymentMethod": "Visa",
"paymentToken": {
"token": 12345689
},
"paymentKind": "Default payment",
"amount": 533.33,
"currency": "USD",
"conversion": 1,
"paymentStatus": "Pending"
}
],
"revision": 0,
"totalQuantity": 10,
"statusDescriptions": [
"<any>"
],
"events": [
"<any>"
],
"pickups": [
"<any>"
],
"attributes": [
"<any>"
],
"createdAt": "2021-05-06T20:00:30.143Z",
"updatedAt": "2021-05-06T20:00:30.143Z"
}Headers
Example:
"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Example:
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Body
application/json
Example:
1234
Example:
"5efcc26a5ee50d00079ca2ab"
Example:
"ORDER_CREATED"
Example:
12
Example:
125.33
Example:
5.23
Example:
"USD"
Example:
"Order has been Shipped"
Example:
"5e3598e3007c5e00080d2bb8"
Example:
"5e3598e3007c5e00080d2bb8"
Example:
"ino@fabric.inc"
Example:
1000001
Example:
"SHIP_TO_ADDRESS"
Example:
"mark@google.com"
Example:
"10400 NE 4th St"
Example:
"Suite 500"
Example:
"Bellevue"
Example:
"WA"
Example:
"USA"
Example:
98004
Example:
"Ship to address"
Example:
24.8723423
Example:
"USD"
Example:
10
Example:
10
Example:
34.87
Example:
"FR020000"
Example:
"Fedex"
Example:
"Express"
Example:
10000001
Example:
"2021-02-14"
Example:
"Leave at back door"
Example:
"Delivered"
Example:
1
Example:
1000011127
Example:
1538910
Example:
"Luminous Cushion Lagoon"
Example:
10
Example:
4.5
Example:
1
Example:
"USD"
Example:
1000001
Example:
10.25
Example:
10.25
Example:
4.54234234
Example:
"FR020000"
Example:
10
Example:
"lb"
Example:
1000001
Example:
4242
Example:
"Visa"
Example:
"Default payment"
Example:
533.33
Example:
"USD"
Example:
1
Example:
"Pending"
Example:
"mark@google.com"
Example:
"10400 NE 4th St"
Example:
"Suite 500"
Example:
"Bellevue"
Example:
"WA"
Example:
"USA"
Example:
98004
Example:
"Ship to address"
Response
200
application/json
Created POS order
Example:
"60944ade71cdfc0008a621a2"
Example:
12
Example:
"testorder"
Example:
125.33
Example:
5.23
Example:
"USD"
Example:
"ORDER_CREATED"
Example:
"Order has been created"
Example:
"5e3598e3007c5e00080d2bb8"
Example:
"5e3598e3007c5e00080d2bb8"
Example:
"ino@fabric.inc"
Example:
"7998-1161-63560"
Example:
"mark@google.com"
Example:
"10400 NE 4th St"
Example:
"Suite 500"
Example:
"Bellevue"
Example:
"WA"
Example:
"USA"
Example:
98004
Example:
"Ship to address"
Example:
"60944ade71cdfc0008a621a3"
Example:
1000001
Example:
"SHIP_TO_ADDRESS"
Example:
24.87
Example:
"USD"
Example:
10
Example:
10
Example:
34.87
Example:
"FR020000"
Example:
"Fedex"
Example:
"Express"
Example:
10000001
Example:
"2021-02-14T00:00:00.000Z"
Example:
"Leave at back door"
Example:
"Delivered"
Example:
"60944ade71cdfc0008a621a4"
Example:
1
Example:
1000000051
Example:
100003
Example:
1538910
Example:
"Luminous Cushion Lagoon"
Example:
10
Example:
4.5
Example:
1
Example:
"USD"
Example:
1000001
Example:
10.25
Example:
10.25
Example:
4.54
Example:
"FR020000"
Example:
10
Example:
"lb"
Example:
"mark@google.com"
Example:
"10400 NE 4th St"
Example:
"Suite 500"
Example:
"Bellevue"
Example:
"WA"
Example:
"USA"
Example:
98004
Example:
"Ship to address"
Example:
"60944ade71cdfc0008a621a5"
Example:
1000001
Example:
"Visa"
Example:
"Default payment"
Example:
533.33
Example:
"USD"
Example:
1
Example:
"Pending"
Example:
0
Example:
10
Example:
"2021-05-06T20:00:30.143Z"
Example:
"2021-05-06T20:00:30.143Z"
Was this page helpful?
curl --request POST \
--url https://prod01-apigw.{customer_name}.fabric.zone/api-order/pos/orders \
--header 'Content-Type: application/json' \
--header 'x-site-context: <x-site-context>' \
--data '{
"channel": 12,
"orderReference": 1234,
"locationId": "5efcc26a5ee50d00079ca2ab",
"orderTotal": 125.33,
"taxTotal": 5.23,
"orderCurrency": "USD",
"status": "ORDER_CREATED",
"statusLog": "Order has been Shipped",
"customerUserId": "5e3598e3007c5e00080d2bb8",
"customerAccountId": "5e3598e3007c5e00080d2bb8",
"customerEmail": "ino@fabric.inc",
"customerPhone": {
"number": "555-555-5555",
"kind": "mobile"
},
"shipTo": [
{
"shipToId": 1000001,
"shipToType": "SHIP_TO_ADDRESS",
"address": {
"name": {
"first": "Mark",
"middle": "p",
"last": "styler"
},
"email": "mark@google.com",
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"price": 24.8723423,
"currency": "USD",
"estimatedTax": 10,
"committedTax": 10,
"promosApplied": [
{
"name": "test1"
}
],
"total": 34.87,
"taxCode": "FR020000",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Express",
"shipmentMethodId": 10000001,
"promisedDeliveryDate": "2021-02-14",
"shipmentInstructions": "Leave at back door",
"shipmentStatus": "Delivered",
"items": [
{
"lineItemId": 1,
"itemId": 1000011127,
"sku": 1538910,
"group": [
"Group1"
],
"title": "Luminous Cushion Lagoon",
"quantity": 10,
"price": 4.5,
"discount": 1,
"currency": "USD",
"shipToId": 1000001,
"estimatedTax": 10.25,
"committedTax": 10.25,
"promosApplied": [
{
"name": "test"
}
],
"total": 4.54234234,
"taxCode": "FR020000",
"weight": 10,
"weightUnit": "lb"
}
],
"shipments": [
"<any>"
],
"payments": [
{
"billToId": 1000001,
"shipToId": [
1000001
],
"paymentIdentifier": {
"cardIdentifier": 4242
},
"paymentMethod": "Visa",
"paymentToken": {
"token": 12345689
},
"paymentKind": "Default payment",
"amount": 533.33,
"currency": "USD",
"conversion": 1,
"paymentStatus": "Pending",
"billToAddress": {
"name": {
"first": "Marl",
"middle": "p",
"last": "styler"
},
"email": "mark@google.com",
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
}
}
]
}
]
}'{
"tags": [
"<any>"
],
"_id": "60944ade71cdfc0008a621a2",
"channel": 12,
"orderReference": "testorder",
"orderTotal": 125.33,
"taxTotal": 5.23,
"orderCurrency": "USD",
"status": "ORDER_CREATED",
"statusLog": "Order has been created",
"customerUserId": "5e3598e3007c5e00080d2bb8",
"customerAccountId": "5e3598e3007c5e00080d2bb8",
"customerEmail": "ino@fabric.inc",
"customerPhone": {
"number": "555-555-5555",
"kind": "mobile"
},
"orderId": "7998-1161-63560",
"shipTo": [
{
"address": {
"name": {
"first": "Mark",
"middle": "p",
"last": "styler"
},
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"email": "mark@google.com",
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"promosApplied": [
{
"name": "test1"
}
],
"_id": "60944ade71cdfc0008a621a3",
"shipToId": 1000001,
"shipToType": "SHIP_TO_ADDRESS",
"price": 24.87,
"currency": "USD",
"estimatedTax": 10,
"committedTax": 10,
"total": 34.87,
"taxCode": "FR020000",
"shipmentCarrier": "Fedex",
"shipmentMethod": "Express",
"shipmentMethodId": 10000001,
"promisedDeliveryDate": "2021-02-14T00:00:00.000Z",
"shipmentInstructions": "Leave at back door",
"shipmentStatus": "Delivered"
}
],
"items": [
{
"group": [
"Group1"
],
"promosApplied": [
{
"name": "test"
}
],
"_id": "60944ade71cdfc0008a621a4",
"lineItemId": 1,
"itemId": 1000000051,
"priceListId": 100003,
"sku": 1538910,
"title": "Luminous Cushion Lagoon",
"quantity": 10,
"price": 4.5,
"discount": 1,
"currency": "USD",
"shipToId": 1000001,
"estimatedTax": 10.25,
"committedTax": 10.25,
"total": 4.54,
"taxCode": "FR020000",
"weight": 10,
"weightUnit": "lb",
"reservedLocation": [
"<any>"
],
"attributes": [
"<any>"
]
}
],
"shipments": [
"<any>"
],
"payments": [
{
"billToAddress": {
"name": {
"first": "Marl",
"middle": "p",
"last": "styler"
},
"phone": {
"number": "555-555-5555",
"kind": "mobile"
},
"email": "mark@google.com",
"street1": "10400 NE 4th St",
"street2": "Suite 500",
"city": "Bellevue",
"state": "WA",
"country": "USA",
"zipCode": 98004,
"kind": "Ship to address"
},
"shipToId": [
1000001
],
"_id": "60944ade71cdfc0008a621a5",
"billToId": 1000001,
"paymentIdentifier": {
"cardIdentifier": 4242
},
"paymentMethod": "Visa",
"paymentToken": {
"token": 12345689
},
"paymentKind": "Default payment",
"amount": 533.33,
"currency": "USD",
"conversion": 1,
"paymentStatus": "Pending"
}
],
"revision": 0,
"totalQuantity": 10,
"statusDescriptions": [
"<any>"
],
"events": [
"<any>"
],
"pickups": [
"<any>"
],
"attributes": [
"<any>"
],
"createdAt": "2021-05-06T20:00:30.143Z",
"updatedAt": "2021-05-06T20:00:30.143Z"
}