Sales Order Create - Single Order

This JSON endpoint enables you to import a single sales order.

Details

Resource
POST stores/{clientId}/orderCreate.json
Headers
-H 'Authorization: Basic ********************************** (Code supplied by Radial.) -H 'Content-Type: application/json' -H 'apiKey: ******************************' (API Key supplied by Radial.)
Sample Request URL
https://tst04-epapi-na.gsipartners.com/v1.0/stores/TMSUS/orderCreate.json

Examples

Sample Request

Copy

{

    "priceInfo": {
        "currency": "USD"
    },
    "customerOrderId": "00026xxx0908003Z22",
    "zoneId": "LVS",
    "orderTimestamp": "2024-02-16T01:55:41Z",
    "lineItems": [
        {
            "lineNo": "1",
            "quantity": 2,
            "unitPrice": 14.95,
            "itemDetail": {
                "itemId": "21-ISPUProd01"
            },
            "shippingAddressRefId": "address_1",
            "additionalAddresses": [],
            "charges": [
                {
                    "id": "1",
                    "isBillable": true,
                    "isDiscount": false,
                    "category": "Price",
                    "name": "Price",
                    "detail": {
                        "amount": 29.90,
                        "perUnit": 14.95,
                        "perLine": 0.00,
                        "shippingCharge": false
                    },
                    "taxes": [
                        {
                            "taxName": "PENNSYLVANIA 31152 Sales and Use Tax\n\t\t\t\t\t\t\t\t\t",
                            "isTaxableFlag": true,
                            "taxPercentage": 0,
                            "amount": 0.00,
                            "customAttributes": [],
                            "category": "Price",
                            "invoicedTax": 0.00,
                            "reference1": "SELLER_USE",
                            "reference3": "0",
                            "impositionType": "General Sales and Use Tax",
                            "impositionValue": "Sales and Use Tax\n\t\t\t\t\t\t\t\t\t",
                            "jurisdiction": "PENNSYLVANIA",
                            "jurisdictionId": "31152",
                            "jurisdictionLevel": "STATE",
                            "originalTax": 0.00,
                            "situs": "DESTINATION"
                        }
                    ],
                    "customAttributes": [],
                    "discounts": [
                        {
                            "id": "1",
                            "isBillable": true,
                            "isDiscount": true,
                            "category": "MerchandiseDiscount",
                            "name": "Promo3",
                            "detail": {
                                "amount": 14.95,
                                "perUnit": 7.47,
                                "perLine": 0.01,
                                "shippingCharge": false
                            },
                            "taxes": [
                                {
                                    "taxName": "PENNSYLVANIA 31152 Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t\t",
                                    "isTaxableFlag": false,
                                    "taxPercentage": 0.0,
                                    "amount": 0.00,
                                    "customAttributes": [],
                                    "category": "MerchandiseDiscount",
                                    "invoicedTax": 0.00,
                                    "reference1": "SELLER_USE",
                                    "impositionType": "General Sales and Use Tax",
                                    "impositionValue": "Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t\t",
                                    "jurisdiction": "PENNSYLVANIA",
                                    "jurisdictionId": "31152",
                                    "jurisdictionLevel": "STATE",
                                    "originalTax": 0.00,
                                    "situs": "DESTINATION"
                                }
                            ],
                            "customAttributes": [
                                {
                                    "name": "promoCode",
                                    "value": "10OFF"
                                },
                                {
                                    "name": "promoDescription",
                                    "value": "2$OffPrice"
                                },
                                {
                                    "name": "promoId",
                                    "value": "Promo3"
                                }
                            ]
                        },
                        {
                            "id": "2",
                            "isBillable": true,
                            "isDiscount": true,
                            "category": "MerchandiseDiscount",
                            "name": "Promo5",
                            "detail": {
                                "amount": 14.95,
                                "perUnit": 7.47,
                                "perLine": 0.01,
                                "shippingCharge": false
                            },
                            "taxes": [
                                {
                                    "taxName": "PENNSYLVANIA 31152 Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t\t",
                                    "isTaxableFlag": false,
                                    "taxPercentage": 0.0,
                                    "amount": 0.00,
                                    "customAttributes": [],
                                    "category": "MerchandiseDiscount",
                                    "invoicedTax": 0.00,
                                    "reference1": "SELLER_USE",
                                    "impositionType": "General Sales and Use Tax",
                                    "impositionValue": "Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t\t",
                                    "jurisdiction": "PENNSYLVANIA",
                                    "jurisdictionId": "31152",
                                    "jurisdictionLevel": "STATE",
                                    "originalTax": 0.00,
                                    "situs": "DESTINATION"
                                }
                            ],
                            "customAttributes": [
                                {
                                    "name": "promoCode",
                                    "value": "100OFF"
                                },
                                {
                                    "name": "promoDescription",
                                    "value": "2$OffPrice"
                                },
                                {
                                    "name": "promoId",
                                    "value": "Promo5"
                                }
                            ]
                        }
                    ],
                    "adjustments": [],
                    "isTaxableFlag": true,
                    "taxClass": "76800"
                },
                {
                    "id": "3",
                    "isBillable": true,
                    "isDiscount": false,
                    "category": "Fees",
                    "name": "CODSurcharge",
                    "detail": {
                        "amount": 1.00,
                        "perUnit": 0.00,
                        "perLine": 1.00,
                        "shippingCharge": false
                    },
                    "taxes": [],
                    "customAttributes": [],
                    "adjustments": [],
                    "isTaxableFlag": false
                },
                {
                    "id": "4",
                    "isBillable": true,
                    "isDiscount": false,
                    "category": "GiftWrap",
                    "name": "GiftWrap",
                    "detail": {
                        "amount": 3.00,
                        "perUnit": 1.50,
                        "perLine": 0.00,
                        "shippingCharge": false
                    },
                    "taxes": [
                        {
                            "taxName": "PENNSYLVANIA 31152 Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t",
                            "isTaxableFlag": false,
                            "taxPercentage": 6,
                            "amount": 0.06,
                            "customAttributes": [],
                            "category": "GiftWrap",
                            "invoicedTax": 0.06,
                            "reference1": "SELLER_USE",
                            "impositionType": "General Sales and Use Tax",
                            "impositionValue": "Sales and Use Tax\n\t\t\t\t\t\t\t\t\t\t",
                            "jurisdiction": "PENNSYLVANIA",
                            "jurisdictionId": "31152",
                            "jurisdictionLevel": "STATE",
                            "originalTax": 0.06,
                            "situs": "DESTINATION"
                        }
                    ],
                    "customAttributes": [
                        {
                            "name": "giftWrapItemId",
                            "value": "21-GiftWrapPrd1"
                        }
                    ],
                    "discounts": [],
                    "adjustments": [],
                    "isTaxableFlag": false,
                    "taxClass": "93000"
                },
                {
                    "id": "2",
                    "isBillable": true,
                    "isDiscount": false,
                    "category": "Shipping",
                    "name": "Shipping",
                    "detail": {
                        "amount": 1.00,
                        "perUnit": 0.00,
                        "perLine": 1.00,
                        "shippingCharge": false
                    },
                    "taxes": [
                        {
                            "taxName": "PENNSYLVANIA 31152 Sales and Use Tax\n\t\t\t\t\t\t\t\t\t",
                            "isTaxableFlag": false,
                            "taxPercentage": 60.0,
                            "amount": 0.06,
                            "customAttributes": [],
                            "category": "Shipping",
                            "invoicedTax": 0.06,
                            "reference1": "SELLER_USE",
                            "impositionType": "General Sales and Use Tax",
                            "impositionValue": "Sales and Use Tax\n\t\t\t\t\t\t\t\t\t",
                            "jurisdiction": "PENNSYLVANIA",
                            "jurisdictionId": "31152",
                            "jurisdictionLevel": "STATE",
                            "originalTax": 0.06,
                            "situs": "DESTINATION"
                        }
                    ],
                    "customAttributes": [],
                    "discounts": [
                        {
                            "id": "1",
                            "isBillable": true,
                            "isDiscount": true,
                            "category": "ShippingDiscount",
                            "name": "Promo4",
                            "detail": {
                                "amount": 0.50,
                                "perUnit": 0.00,
                                "perLine": 0.50,
                                "shippingCharge": false
                            },
                            "taxes": [],
                            "customAttributes": [
                                {
                                    "name": "promoCode",
                                    "value": "HalfOFF"
                                },
                                {
                                    "name": "promoDescription",
                                    "value": "HalfOffPrice"
                                },
                                {
                                    "name": "promoId",
                                    "value": "Promo4"
                                }
                            ]
                        }
                    ],
                    "adjustments": [],
                    "isTaxableFlag": false,
                    "taxClass": "93000"
                }
            ],
            "customAttributes": [
                {
                    "name": "COD_SURCHARGE_GRP_ID",
                    "value": "cod_1"
                },
                {
                    "name": "giftWrapItemId",
                    "value": "21-GiftWrapPrd1"
                },
                {
                    "name": "requestLineId",
                    "value": "item_1"
                }
            ],
            "instructions": [
                {
                    "sequenceNumber": 2,
                    "type": "GIFT",
                    "value": "Maninder"
                },
                {
                    "sequenceNumber": 4,
                    "type": "GIFT",
                    "value": "Behl"
                },
                {
                    "sequenceNumber": 5,
                    "type": "GIFT",
                    "value": "Happy testing 1 - Blue wrap!"
                }
            ],
            "orderDates": [
                {
                    "type": "FROM_EDD",
                    "expected": "2024-02-18T02:49:52Z"
                },
                {
                    "type": "TO_EDD",
                    "expected": "2024-02-18T02:49:52Z"
                },
                {
                    "type": "MIN_SHIPMENT",
                    "expected": "2024-02-18T02:49:52Z"
                },
                {
                    "type": "MAX_SHIPMENT",
                    "expected": "2024-02-18T02:49:52Z"
                }
            ],
            "fulfillmentMethod": "SHIP_TO_HOME",
            "isAssociateDelivery": "false",
            "isCurbsidePickup": "false",
            "isGiftWrapItem": true,
            "color": "Brown",
            "colorCode": "700",
            "isHiddenGift": false,
            "isShipAlone": false,
            "shipGroupId": "shipgroup_1",
            "shippingChargeType": "FLATRATE",
            "shippingMethodName": "ANY_2DAY",
            "size": "6-M",
            "sizeCode": "6-M",
            "sublineIdSeq": 0,
            "isCompanion": false,
            "isRushOrder": false,
            "isTipLine": false,
            "isReturnComplete": false,
            "isShipFromEqualToShipTo": "false",
            "isPresell": "false",
            "originalTotalQuantity": 2,
            "totalQuantity": 2,
            "reservationId": "0002687909219553"
        }
    ],
    "customAttributes": [
        {
            "name": "AltOrderNum1",
            "value": "WB206409479"
        },
        {
            "name": "MAJOR_ORDER_GRP_ATTR",
            "value": "shipgroup_1"
        }
    ],
    "lineItemRelationships": [],
    "entryType": "EB2C",
    "orderClosed": false,
    "isOrderTaxPresent": true,
    "locale": "en_US",
    "orderSourceCode": "EB2C",
    "customerInfo": {
        "customerName": "Indiana Jones",
        "email": "testapprove@radial.com",
        "phone": "6102223333",
        "firstName": "Indiana",
        "lastName": "Jones",
        "customerId": "null1716625225"
    },
    "createTimestamp": "2024-02-16T15:19:15.44Z",
    "updateTimestamp": "2024-02-16T15:19:15.44Z",
    "releaseGroupIdSeq": 0,
    "addresses": [
        {
            "addressId": "address_1",
            "addressType": "MailingAddress",
            "addressLine1": "630 Allendale Road",
            "firstName": "Indiana",
            "lastName": "Jones",
            "email": "testapprove@radial.com",
            "city": "King of Prussia",
            "phone": "6102223333",
            "stateOrProvinceCode": "PA",
            "countryCode": "US",
            "zipCode": "19406",
            "pobox": false
        }
    ],
    "billingAddressRefId": "address_1",
    "archivedOrder": false,
    "isVATInclusive": false,
    "paymentMethods": [
        {
            "code": "PREPAID_CARD",
            "tenderType": "PR",
            "processorId": "",
            "chargeType": "",
            "requestedAuthAmount": 0.00,
            "requestedChargeAmount": 0.00,
            "totalAltRefundedAmount": 0.00,
            "totalAuthorizedAmount": 0.00,
            "totalCharged": 0.00,
            "totalRefundedAmount": 0.00,
            "legacyPaymentType": "PR",
            "amount": 39.33,
            "brand": "Gift Card",
            "isSuspendAnyMoreCharge": false
        }
    ],
    "fraudDetails": [
        {
            "id": "1",
            "transactionType": "ORDER_CREATE",
            "status": "PENDING",
            "details": [
                {
                    "name": "ConnectionType",
                    "value": "keep-alive"
                },
                {
                    "name": "RawCookie",
                    "value": "s_nr=1328113718440;     certona_tracking_parameter=l0.sFfEdofcAAAE1W1R.LV4r;     BrowserID_TMSEU-TMSDE-Site=J0.sFfEd6_gAAAE1Zf0HiWj7;     BrowserIDCreationTime=1328906239333;     cc-cFmsFfEdGpMAAAE1iBNzYkwY=zYWsFfEdtgEAAAE14RAHiWj8;     s_rdcvpc=%5B%5B'www.sandbox.paypal.com'%2C'1329321571382'%5D%5D;     sid=vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG;     pgid-TMSEU-TMSDE-Site=CQVYEt.CH5dSRpcGb9CmasMe0000zLzZeRBA;     cc-fYqsFfEd2t8AAAE1oShFf42l=z6esFfEd2pEAAAE10k00oaVb;     WA_ReferrerSource=-; s_cc=true;     __utma=172174241.570529138.1328906240.1328906240.1329919076.2;     __utmb=172174241.7.10.1329919076; __utmc=172174241;     __utmz=172174241.1328906240.1.1.utmcsr=(direct)|utmccn=(direct)|utmcmd=(none);     s_previousPageName=Checkout%3A%20Review%20and%20Submit%20Order;     s_sq=gsictmsdedev%3D%2526pid%253DCheckout%25253A%252520Review%252520and%252520Submit%252520Order%2526pidt%253D1%2526oid%253DSubmit%252520Order%2526oidt%253D3%2526ot%253DSUBMIT    "
                },
                {
                    "name": "HostName",
                    "value": "sectst02-live.us.gspt.net"
                },
                {
                    "name": "DeviceIP",
                    "value": "208.247.73.130"
                },
                {
                    "name": "SessionID",
                    "value": "vtP0bAUqN7j0bEpuSrHnnBCG40gigFixaD-p99PG"
                },
                {
                    "name": "JavascriptData",
                    "value": "TF1;015;;;;;;;;;;;;;;;;;;;;;;Mozilla;Netscape;5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;20030107;undefined;true;;true;Win32;undefined;Mozilla/5.0%20%28Windows%20NT%206.1%3B%20WOW64%29%20AppleWebKit/535.11%20%28KHTML%2C%20like%20Gecko%29%20Chrome/17.0.963.56%20Safari/535.11;en-US;ISO-8859-1;sectst02-live.us.gspt.net;undefined;undefined;undefined;undefined;true;false;1329919276230;-5;Tue%20Jun%2007%202005%2021%3A33%3A44%20GMT-0400%20%28Eastern%20Daylight%20Time%29;1440;900;;10.3;;;;;3;300;240;Wed%20Feb%2022%202012%2009%3A01%3A16%20GMT-0500%20%28Eastern%20Standard%20Time%29;32;1378;900;0;0;;;;;;Shockwave%20Flash%7CShockwave%20Flash%2011.1%20r102;;;;;;;;;Silverlight%20Plug-In%7C4.0.60531.0;;;;15;    "
                },
                {
                    "name": "Referer",
                    "value": "https://sectst02-live.us.gspt.net/gsi/webstore/WFS/TMSEU-TMSDE-Site/de_DE/-/EUR/ViewData-Start/1749939151?JumpTarget=ViewCheckoutReview-Start\n\t\t\t"
                },
                {
                    "name": "UserAgent",
                    "value": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.11\n\t\t\t\t(KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11"
                },
                {
                    "name": "AcceptCharset",
                    "value": "ISO-8859-1,utf-8;q=0.7,*;q=0.3"
                },
                {
                    "name": "Accept",
                    "value": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\t\t\t\t"
                },
                {
                    "name": "AcceptEncoding",
                    "value": "gzip,deflate,sdch"
                },
                {
                    "name": "AcceptLanguage",
                    "value": "en-US,en;q=0.8"
                },
                {
                    "name": "TDLOrderTS",
                    "value": "2024-02-10T17:36:27"
                }
            ]
        }
    ],
    "checkInventory": true,
    "type": "SALES"
}

Sample Response

HTTP Status 200: Success

Copy

 {

 
    "0002637181350853ZA3": "SUCCESS"

 
}

Open API Specifications and Field Definitions

Field Definitions

SalesOrderCreate API

	Type	Required	Constraints	Comments
orderDocuments	Complex		1 or more required	Contains one or moreSales Orders. Sales Orders contain all of the other elements below.
priceInfo	Complex			Contains the "currency" element.
customerOrderId	String	Yes		The order id generated by the webstore.
zoneId	String			Radial Data Center locations. Typically either ASH or LVS
orderTimestamp	Date	Yes		Date, time, and time zone informationISODate format is "2023-12-15T10:00:00Z".
lineItems	Array		min = 1	List of LineItem. Each LineItem contains multiple elements such as: "lineNo", "quantity, "unitPrice", charges, etc. A LineItem must have at least one Pricing/Merchandise Charge element.
lineNo	String	Yes	Allowable Values: 1 to 999.	The line number associated with an item in an order. Line numbers must be unique within a submitted order. It is recommended to start line numbers in an order with "1" Length: 3 characters
quantity	Integer	Yes	Positive Integer	Total line quantity ordered
unitPrice	Decimal	Yes	Decimal to two digits	Individual unit price for each item on the line. OMS requires the value from this field
itemDetail	Complex	Yes		Contains the element"itemId"
itemId	String	Yes		This identifier includes the catalog ID and the item's unique ID within that catalog. The syntax for this identifier is: catalogId + "-" + clientItemId
shippingAddressRefId	String	Yes		The shippingAddressRefId is what links shipping address to a lineItem. The address Id will have same value as shippingAddressRefId
additionalAddresses	Array			List of Address
charges	Complex			List of Charge information indexed by Id. Each Charge contains multiple elements such as "id", "isBillable", "isDiscount", "category", "detail", "taxes", "customAttributes", etc.
customAttributes	Complex			CustomAttributes at the lineItems/ level
instructions	Complex	Yes		List of instructions indexed by sequenceNumber. An instruction contains the elements "sequenceNumber", "type", "value".
orderDates	Complex			List of four OrderDates key/value pairs with the key string "type" and theDate value "expected".
fulfillmentMethod	String	Yes	Allowable Values: SHIP_TO_STORESTORE_PICK_UPSHIP_TO_HOME	How the order is completed.
isAssociateDelivery	String			Not needed for public API. Indicates if line requires associated delivery. Either "true" or "false" as a String
isCurbsidePickup	String			Not needed for public API. Indicates if line is enabled for Curbside pickup. Either true or false
isGiftWrapItem	boolean		Pre-populated	Internal Use. Okay to exclude from external documentation.
color	String		Pre-populated	Will use if sent. Obtains value from Item Master
colorCode	String		Pre-populated	Will use if sent. Obtains value from Item Master
isHiddenGift	boolean			If hidden gift line, send true else false
isShipAlone	boolean			If ship alone line, send true else false
shipGroupId	String	Yes		unique identifier for the ship group that the item belongs to (based on the destination address it is shipping to). If one of more lines are shipping to the same address, then all those items would have the same shipGroupId.
shippingChargeType	String	Yes	Available option: FLATRATE	The type of shipping charge.
shippingMethodName	String			Concatenated "carrier"+"_"+"service"Carrier: represents the logical Carriers (SCAC) and modes (CarrierServiceCode) Shipping Carrier such as "UPS" or "FEDEX" or "ANY"Service: represents the Carrier mode is such as 1Day or Ground, etc.
size	String		Pre-populated	Will use if sent. Obtains value from Item Master
sizeCode	String		Pre-populated	Will use if sent. Obtains value from Item Master
sublineIdSeq	Integer		Pre-populated	Internal Use. Okay to exclude from external documentation. Obtains value from Item Service
isCompanion	boolean			Not needed for public API. true or false
isRushOrder	boolean			Not needed for public API. true or false
isTipLine	boolean			Not needed for public API. true or false
isReturnComplete	boolean			Not needed for public API. true or false
isShipFromEqualToShipTo	String			Not needed for public API. Either "true" or "false" as a String
isPresell	String			Not needed for public API. Either "true" or "false" as a String
originalTotalQuantity	Integer	Yes		Original Total Quantity
totalQuantity	Integer			Not needed for public API. Total Quantity
reservationId	String			Reservation Id
customAttributes	Complex			Custom Attributes at the header/ level.
lineItemRelationships	Complex			List of Item Relationships.
entryType	String		EB2C	populated with default values entryType - EB2C
orderClosed	boolean		true or false	Is order closed. Use false
isOrderTaxPresent	boolean		true or false	Is Order Tax present
locale	String	Yes		Allowable Values: ISO-639 two-letter language code, an underscore (_) andISO-3166 two-letter code, for example: en_US
orderSourceCode	String		EB2C	Use EB2C
customerInfo	Complex			Encapsulates Customer Information and contains multiple element including "customerName", "email", "firstName", "lastName", "phone" etc.
createTimestamp	Date			Date, time, and time zone informationISODate format is "2023-12-15T10:00:00Z".
updateTimestamp	Date			Date, time, and time zone informationISODate format is "2023-12-15T10:00:00Z".
releaseGroupIdSeq	Integer
addresses	Complex			List of Addresses Each of which encapsulates Address Information, indexed on a unique "addressId". Each Address contains a set of multiple elements including "addressId", "addressType", "addressLine1", "firstName", "lastName", "email", etc.
billingAddressRefId	String	Yes		The billingAddressRefId is what links billing address to a lineItem. The address Id will have same value as billingAddressRefId.
archivedOrder	boolean			true or false
isVATInclusive	boolean			true or false
paymentMethods	Complex			Encapsulates Payment Method information and includes multiple elements including "code", "tenderType", "processorId", "chargeType", "requestedAuthAmount", "requestedChargeAmount", "totalAltRefundedAmount" and the elements vary depending on the "code" and "tenderType" values Refer to the Payment Method Field Definitions by Payment Scenario section below for more details
code	String		Pre-populated	Internal Use. Okay to exclude from external documentation. CreditCard maps to code : CREDIT_CARD,PrepaidCreditCard type="PR" maps to code : PREPAID_CARD,PrepaidCashOnDelivery maps to code : PREPAID_CARD,StoredValueCard maps to code : STORED_VALUE_CARD,PayPal maps to code : PAYPAL
tenderType	String	Yes		This element identifies the payment method. Example values: VC - VisaMC - Master CardOGC - Online Gift CertificateSM - Maestro UKSO - Solo UKGift card tender type codes are provider specific.Example values:BH - BlackhawkSP - SVSPY - PaypalBL - Bill Me LaterCVS - CVSCOD - CODBR - "Prepaid" tender
customAttributes	Complex			Custom Attributes at the /paymentMethods level
processorId	String			Processor ID
chargeType	String		FLATRATE	Use FLATRATE
requestedAuthAmount	Decimal		Decimal to two digits	The requested authorization amount
requestedChargeAmount	Decimal		Decimal to two digits	The requested charge amount
totalAltRefundedAmount	Decimal		Decimal to two digits	The total alt refunded amount
totalAuthorizedAmount	Decimal		Decimal to two digits	The total authorized amount
totalCharged	Decimal		Decimal to two digits	The total charge
totalRefundedAmount	Decimal		Decimal to two digits	The total refunded amount
legacyPaymentType	String	Yes		The legacy payment type. Required in validation.
amount	Decimal		Decimal to two digits	The amount
brand	String			Only used forPREPAID_CARD, brand name of the credit card used. Not validated, any value will work. For example, "Visa", "Mastercard", etc.
fraudDetails				List of Fraud Details
isSuspendAnyMoreCharge	boolean			true or false
checkInventory	boolean			true or false
type	String	Yes	SALES	The order type for example SALES, RETURN, PURCHASE, TRANSFER. Currently only SALES is supported

fraudDetails	Array			List of Fraud Details indexed by Id which includes elements such as "id",. transactionType", "status", and "details"
id	String			Fraud Detail identifier.
transactionType	String		ORDER_CREATE	The transaction type, for example ORDER_MODIFY, ORDER_CREATE. Currently on ORDER_CREATEis supported. Use ORDER_CREATE.
status	String		PENDING	Indicates the status of the order for example PENDING, ACCEPTED, CANCELLED, SENT. Currently on PENDING is supported. Use PENDING.
details	Array			The details elements encapsulates HTTP Header information from the create order request. When fraudDetails is used, all thirteen key/value pairs for request headers must be provided
name	String		Use one each of 13:key values ConnectionTypeRawCookieHostNameDeviceIPSessionIDJavascriptDataRefererUserAgentAcceptCharsetAcceptAcceptEncodingAcceptLanguageTDLOrderTS	One of: ConnectionType, RawCookie, HostName, DeviceIP, SessionID, JavascriptData, Referer, UserAgent, AcceptCharset, Accept, AcceptEncoding, AcceptLanguage, TDLOrderTS key names
value	String		Use one each of 13:for values	One value for each of the 13 key names

charges	Complex			List of Charge information indexed by Id. Each Charge contains multiple elements such as "id", "isBillable", "isDiscount", "category", "detail", "taxes", "customAttributes", etc.
id	String			Unique sequential identifier at the lineItems/ charges/ level for the line charge.
category	String	Yes		Category at the lineItems/ charges/ level. Identifies the type of charge. Applicable Charge Categories arePrice – needs set of disc types definedShippingCustomizationFeesGiftWrapDuty
name	String	Yes		Name of the charge (same as category)
detail	Complex			Detail at the lineItems/ charges/ level.
taxes	Comlex			Taxes at thelineItem/charges/level
customAttributes	Complex			CustomAttributes at the lineItems/ charges/level
discounts	Complex			Discounts at the lineItems/ charges/ level
adjustments	Array			Leave un populates
isTaxableFlag	boolean
taxClass	String

customerInfo	Complex			Encapsulates Customer Information and contains multiple element including "customerName", "email", "firstName", "lastName", "phone" etc.
customerName	String			Customer Name at the /customerInfo level
loyaltyProgram	String			Information about a loyalty program, thet typically provides a discount or special offers to its members. Includes shopper account information, the loyalty program name, and details about the customer's membership, such as the customer's loyalty program number
loyaltyNumber	String			The customer's loyalty program number
email	String			Customer eMail at the /customerInfo level
phone	String			Customer phone at the /customerInfo level
firstName	String	Yes		Customer first name at the /customerInfo level
lastName	String	Yes		Customer last name at the /customerInfo level
customerId	String		Length: 40	Assigned by the system that is taking the order. This can be either an ID created by the customer, for example, when the customer created an account, or, if the customer did not want to create an account, the system creates an ID, which is then used for guest checkouts. Therefore this


addresses	Complex			List of Addresses Each of which encapsulates Address Information, indexed on a unique "addressId". Each Address contains a set of multiple elements including "addressId", "addressType", "addressLine1", "firstName", "lastName", "email", etc.
addressId	String			The unique identifier for this address.
addressType	String			One of MailingAddress, StoreLocation, Email, MCI_PROXY_ADDRESS, GSI_STORE_FRONT. Post Office Box (do not pass PO Box as part of the request. e.g. 765)
addressLine1	String	Yes		Street address associated with an address/ Required in validation.
firstName	String			First name associated with an address/
lastName	String			Last name associated with an address/
email	String			Email associated with an address/
city	String	Yes		Cityassociated with an address/
phone	String			Phoneassociated with an address/
stateOrProvinceCode	String	Yes		The state or province code associated with an address/ Required in validation.
countryCode	String			The country code associated with an address/
zipCode	String	Yes		The zip code associated with an address/ Required in validation.
pobox	boolean		false	Use false

customAttributes	Complex			Custom Attributes always contain the elements "name" and "value' and appear at multiple levels including: Header level customAttributeslineItems/ level customAttributeslineItems/ charges/ level customAttributeslineItems/ charges/ discounts/ level customAttributeslineItems/ charges/ taxes/ level customAttributeslineItems/ charges/ discounts/ taxes/ level customAttributes
name	String			Custom attribute key name
value	String			Custom attribute value

detail	Complex			Each Detail will contain multiple elements such as "amount", "perUnit", "perLine", "shippingCharge" etc.
amount	Decimal	Yes	Decimal to two digits. Must be < charge amount	This field is a computed amount. Amount - remainder = UnitPrice * Quantity Amount = (UnitPrice * Quantity) + remainder For example, Amount is 100 and the quantity is 3. The amount would be 100.00, the remainder would be 0.01, and the UnitPrice would be 33.33. Remainder refers to the VAT (Value Added Tax.. the price of the item already has tax included) remainder that can occur whenthe total amount divided by the ordr item quantity does not come out even.
perUnit	Decimal		Decimal to two digits	Price per unit
perLine	boolean		Decimal to two digits	The perLine at the lineItems/ charges/ level. This field contains an amount that is added to the odd item. For example if the promotion is buy 3 items for $10, this amount shows $0.01, and if it is buy 3 for $100, then the remainder is $1. This is used when you cannot enter different unit prices for multiple items on a single line.
shippingCharge	boolean			true or false

taxes	Complex			List of Taxes. Each Tax contains multiple elements such as "taxName", "isTaxableFlag", "taxPercentage", "amount", "customAttributes" etc. Taxes appear at multiple levels including the lineItems/ charges/ taxes/ and lineItems/ charges/ discounts/ taxes/ levels
taxName	String	Yes	Pre-populates	Jurisdiction + jurisdictionId + impositionValue
isTaxableFlag	boolean	Yes		This field is based on tax data - TAXABILITY value If TAXABILITY=TAXABLE, then isTaxableFlag = true else isTaxableFlag = false. TAXABILITY: System determination of taxable status based on situs and item type. The possible values are shown below: TAXABLE - item is taxableNONTAXABLE - item is nontaxableEXEMPT - item is exempt from taxDPPAPPLIED - Direct Pay Permit was used on this transaction.NO_TAX - no tax on this itemDEFERRED - tax deferred on this item
taxPercentage	Integer			This field is based on tax data EFFECTIVERATEvalue EFFECTIVERATE: For Buyer Input tax and Seller Import tax, this rate is calculated based on the Extended Price and Tax Amount (Import or Input) passed in the Request message. If you total the Extended Price and Tax Amounts before passing them in, this rate is an average. For all other message types, this is the effective rate the system used to calculate tax.
amount	Decimal		Decimal to two digits	This field is based on tax data CalculatedTax value. Amount = CalculatedTax CalculatedTax: Amount of tax calculated by the calculation engine.Represents a decimal representation of currency. Sample value: 4.75.
customAttributes	Complex			CustomAttributes at the lineItems/ charges/ taxes/ level
category	String			Category at the lineItems/ charges/ taxes/ level. Categories are Price – needs set of disc types definedShippingCustomizationFeesGiftWrapDuty
invoicedTax	Decimal		Decimal to two digits	InvoicedTax = CalculatedTax
reference1	String	Yes		The System determined tax type, based on situs, transaction type, and party role type. Allowable Values: SALES SELLER_USE CONSUMERS_USEVATIMPORT_VATNONE
reference3	String			Internal
impositionType	String	Yes	Length: 60	Categorizes the tax being imposed. Examples include General Sales and Use Tax, Surcharge, and VAT.
impositionValue	String			The name of the imposition to which the relevant tax rule belongs
jurisdiction	String			The name of jurisdiction to which a tax is applied
jurisdictionId	String	Yes		Jurisdiction code assigned by the relevant governmental authority.
jurisdictionLevel	String	Yes		Identifies the jurisdiction's common classification based on its geopoliticaland/or taxing context. The values listed below are recommended and commonly used.APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPO LOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCE SPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
originalTax	Decimal		Decimal to two digits	originalTax = CalculatedTax
situs	String			The situs or taxing location as determined by the calculation engine for the line item

discounts	Complex			List of discounts indexed by Id. The lineItems/ charges/ discounts/ contains multiple elements such as "id", "isBillable", "isDiscount", "category", "name", "detail", "taxes", "customAttributes", etc.
id	String			Unique sequential identifier for the discount
isBillable	boolean		Pre-populated	Internal Use. Okay to exclude from external documentation.
isDiscount	boolean		Pre-populated	Internal Use. Okay to exclude from external documentation.
category	String	Yes		Category at the lineItems/ charges/ discounts/ levelAvailable options are: Price - MerchandiseDiscountShipping - ShippingDiscountGiftWrap - GiftWrapDiscount
name	String	Yes		The name given to this discount.
detail	Complex			Detail at the lineItems/ charges/ discounts/ level
taxes	Complex			Taxes at the lineItems/ charges/ discounts/ level Taxes contains elements including "taxName", "isTaxableFlag", "taxPercentage", "amount", "customAttributes" etc.
customAttributes	Complex			Custom Attributes at the lineItems/ charges/ discounts/ level

instructions				List of instructions indexed by sequenceNumber. An instruction contains the elements "sequenceNumber", "type", "value". Below is an instruction sample which needs to be sent at lineItems/ charges/ level for GiftWrap: "instructions": [ {"sequenceNumber": 2,"type": "GIFT","value": "Maninder"},{"sequenceNumber": 4,"type": "GIFT","value": "Behl"},{"sequenceNumber": 5,"type": "GIFT","value": "Happy testing 1 - Blue wrap!"} ]
sequenceNumber	Integer			A unique sequential number which indicates index of this instruction.
type	String			The instructions category type. Available options are:DST_PACKDST_GIFTGIFT_ITEMGIFTPACKSHIPPINGPRICEGIFT_WRAPCUSTOMIZATIONCUSTOMIZATION_DISCOUNTDUTY
value	String			The instruction message.

priceInfo	Complex			Contains the "currency" element.
currency	String	Conditionally	Required: Only when a transaction amount is specified.	The code that represents the type of currency being used for a transaction. Currency codes are defined by ISO 4217:2008 See: http://en.wikipedia.org/wiki/ISO_4217

lineItemRelationships	Complex			List of Item Relationships. Additional info types of relationships / customizations / ship together / bundle handled in code
relationshipType	String		Customization	Use Customization
parentLineId	String			The parent line Id
childLineId	String			The child line Id
isBundle	boolean			true if is bundle

orderDates	Complex			List of four OrderDates key/value pairs with the key string "type" and theDate value "expected".The specfied types are: Below is the sample of orderDates to be sent "orderDates": [{"type": "FROM_EDD","expected": "2023-09-08T02:49:52Z" <<holds delivery window from date>>},{"type": "TO_EDD","expected": "2023-09-08T02:49:52Z" <<holds delivery window to date>>},{"type": "MIN_SHIPMENT","expected": "2023-09-08T02:49:52Z" <<holds min shipment date>>},{"type": "MAX_SHIPMENT","expected": "2023-09-08T02:49:52Z" <<holds max shipment date>>}]
type	String		Use one each of four: FROM_EDDTO_EDDMIN_SHIPMENTMAX_SHIPMENT	One of four OrderDates keys. When using orderDate include all four types.
expected	Date			Date, time, and time zone informationISODate format is "2023-12-15T10:00:00Z".

Payment Methods

When paymentMethod isPREPAID_CARDand tenderType is NOT COD the paymentMethod will contain the following fields:	When paymentMethod isPREPAID_CARDand tenderType isCODthe paymentMethod will contain the following fields:	When paymentMethod isSTORED_VALUE_CARDpaymentMethod will contain the following fields:	When paymentMethod isPAYPALpaymentMethod will contain the following fields:	When paymentMethod isCREDIT_CARDpaymentMethod will contain the following fields:
code (will be "PREPAID_CARD")	code (will be "PREPAID_CARD"	code (will be "STORED_VALUE_CARD")	code (will be "PAYPAL")	code (will be "CREDIT_CARD")
tenderType (of type Enum)	tenderType (will be "COD")	tenderType (of type Enum)	tenderType (of type Enum)	tenderType (of type Enum)
processorId (of type String)	processorId (of type String) : "",	processorId (of type String)	processorId (of type String)	totalAuthorizedamount (of type Decimal)
chargeType (of type String)	chargeType (of type String)	chargeType (of type String)	chargeType (of type String)	custom Attributes (will have multiple key/value pairs)
requestedAuthamount (of type Decimal)	requestedAuthamount (of type Decimal)	requestedAuthamount (of type Decimal)	requestedAuthamount (of type Decimal)	name (will be "WalletType")
requestedChargeamount (of type Decimal)	requestedChargeamount (of type Decimal)	requestedChargeamount (of type Decimal)	requestedChargeamount (of type Decimal)	value (of type String)
totalAltRefundedamount (of type Decimal)	totalAltRefundedamount (of type Decimal)	totalAltRefundedamount (of type Decimal)	totalAltRefundedamount (of type Decimal)	name (will be "paymentSessionId")
totalAuthorizedamount (of type Decimal)	totalAuthorizedamount (of type Decimal)	totalAuthorizedamount (of type Decimal)	totalAuthorizedamount (of type Decimal)	value (of type String)
totalCharged (of type Decimal)	totalCharged (of type Decimal)	totalCharged (of type Decimal)	totalCharged (of type Decimal)	name (will be "AuthTime")
totalRefundedamount (of type Decimal)	totalRefundedamount (of type Decimal)	totalRefundedamount (of type Decimal)	totalRefundedamount (of type Decimal)	value (of type ISODate)
legacyPaymentType (of type String)	custom Attributes (will have multiple key/value pairs)	custom Attributes (will have multiple key/value pairs)	custom Attributes (will have multiple key/value pairs)	name (will be "ResponseCode")
amount (of type Decimal)	name (will be "type")	name (will be "WalletType")	name (will be "WalletType)	value (of type String)
brand	value (will be "COD")	value (of type String)	value (of type String)	name (will be "AuthCode")
isSuspendAnyMoreCharge		name (will be "AuthTime")	name (will be "AuthTime")	value (of type String)
		value (of type ISODate)	value (of type ISODate)	name (will be "CVV2ResponseCode")
		legacyPaymentType (of type String)	name (will be "ResponseCode")	value (of type String)
		amount (of type Decimal)	value (of type String)	name (will be "AuthAVS")
		paymentRequestId (of type String)	name (will be "paymentSessionId")	value (of type String)
		storedValueCardNumber (of type String)	value (of type String)	name (will be "AuthorizationID")
		pin (of type String)	legacyPaymentType (of type String)	value (of type String)
		isTokenized (of type boolean)	amount (of type Decimal)	name (will be "CVVAuthCode")
		isSuspendAnyMoreCharge (of type boolean)	paymentRequestId (of type String)	value (of type String)
			payPalNumber (of type String)	legacyPaymentType (of type String)
			isTokenized (of type boolean)	creditCardNumber (of type String)
			isSuspendAnyMoreCharge (of type boolean)	displayCreditCardNumber (of type String)
				name (of type String)
				expiryDate (of type String)
				maxChargeLimit (of type Integer)
				amount (of type Decimal)
				isTokenized (of type boolean)
				isSuspendAnyMoreCharge (of type boolean)

Payment Method Examples

Prepaid Card

Copy

"paymentMethods": [
    {
        "code": "PREPAID_CARD",
        "tenderType": "PR",
        "processorId": "",
        "chargeType": "",
        "requestedAuthAmount": 0.00,
        "requestedChargeAmount": 0.00,
        "totalAltRefundedAmount": 0.00,
        "totalAuthorizedAmount": 0.00,
        "totalCharged": 0.00,
        "totalRefundedAmount": 0.00,
        "legacyPaymentType": "PR",
        "amount": 39.33,
        "brand": "Gift Card",
        "isSuspendAnyMoreCharge": false
    }

Store Value Card / Credit Card

Copy

"paymentMethods": [
        {
            "code": "CREDIT_CARD",
            "tenderType": "AM",
             
            "totalAuthorizedAmount": 433.36,
             
            "customAttributes": [
                {
                    "name": "paymentSessionId",
                    "value": "0002626271157053_cancel031124"
                },
                {
                    "name": "AuthTime",
                    "value": "2024-03-07T01:09:37"
                },
                {
                    "name": "ResponseCode",
                    "value": "APPROVED"
                },
                {
                    "name": "AuthCode",
                    "value": "000032"
                },
                {
                    "name": "CVV2ResponseCode",
                    "value": "M"
                },
                {
                    "name": "AuthAVS",
                    "value": "Y"
                },
                {
                    "name": "AuthorizationID",
                    "value": "APPROVED"
                },
                {
                    "name": "CVVAuthCode",
                    "value": "M"
                }
            ],
            "legacyPaymentType": "CC",
            "creditCardNumber": "3700A0NO7LO0101",
            "displayCreditCardNumber": "0101",
            "name": "IndianaJones",
            "expiryDate": "2022-09",
             
            "isTokenized": true
        },
        {
            "code": "STORED_VALUE_CARD",
            "tenderType": "GS",
             
            "totalCharged": 50.0,
             
            "customAttributes": [
                {
                    "name": "AuthTime",
                    "value": "2020-04-19T21:25:35"
                }
            ],
            "legacyPaymentType": "GC",
            "amount": 50.0,
            "paymentRequestId": "62f622f4-93b6-4691-ba42-20e5f2d10f4c",
            "storedValueCardNumber": "810002R7rSS5105",
            "pin": "1234",
            "isTokenized": true
        },
        {
            "code": "STORED_VALUE_CARD",
            "tenderType": "SV",
             
            "totalCharged": 10.0,
             
            "customAttributes": [
                {
                    "name": "AuthTime",
                    "value": "2016-10-25T10:00:00.338Z"
                }
            ],
            "legacyPaymentType": "GC",
            "amount": 10.0,
            "paymentRequestId": "K0YKMcCcifMAAAFMDlwU.JjH",
            "storedValueCardNumber": "696928k1RZeY0002",
            "pin": "1234",
            "isTokenized": true
     
        }
    ],

Paypal

Copy

"paymentMethods": [
    {
        "code": "PAYPAL",
        "tenderType": "PY",
        "processorId": "",
        "chargeType": "",
        "requestedAuthAmount": 246.33,
        "requestedChargeAmount": 0.0,
        "totalAltRefundedAmount": 0.0,
        "totalAuthorizedAmount": 246.33,
        "totalCharged": 0.0,
        "totalRefundedAmount": 0.0,
        "customAttributes": [
            {
                "name": "WalletType",
                "value": "AliPay"
            },
            {
                "name": "AuthTime",
                "value": "2024-03-06T17:57:12"
            },
            {
                "name": "ResponseCode",
                "value": "Success"
            },
            {
                "name": "paymentSessionId",
                "value": "0002693864498953_ocs8a"
            }
        ],
        "legacyPaymentType": "PY",
        "amount": 246.33,
        "paymentRequestId": "0c364861-d93a-41a3-a79f-c1efa1df3c54",
        "payPalNumber": "****-****-****-YPAL",
        "isTokenized": false,
        "isSuspendAnyMoreCharge": false
    }
],

Credit Card

Copy

"paymentMethods": [
    {
        "code": "CREDIT_CARD",
        "tenderType": "VC",
     
        "totalAuthorizedAmount": 115.75,
     
        "customAttributes": [
            {
                "name": "paymentSessionId",
                "value": "0002624660118953_orderMod175"
            },
            {
                "name": "AuthTime",
                "value": "2024-03-07T03:13:21"
            },
            {
                "name": "ResponseCode",
                "value": "APPROVED"
            },
            {
                "name": "AuthCode",
                "value": "000032"
            },
            {
                "name": "CVV2ResponseCode",
                "value": "M"
            },
            {
                "name": "AuthAVS",
                "value": "Y"
            },
            {
                "name": "AuthorizationID",
                "value": "APPROVED"
            },
            {
                "name": "CVVAuthCode",
                "value": "M"
            }
        ],
        "legacyPaymentType": "CC",
        "creditCardNumber": "4111B1BPF08a1111",
        "displayCreditCardNumber": "1111",
        "name": "JennyWhite",
        "expiryDate": "2026-09",
     
        "isTokenized": true
    }
],