{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"order","type":"basic","slug":"order","excerpt":"","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`ordering-shopper`\",\n \"0-1\": \"container\",\n \"h-3\": \"Description\",\n \"0-3\": \"Container of [ordering-shopper](doc:ordering-shopper) properties.\",\n \"1-0\": \"`cart`\",\n \"1-1\": \"container\",\n \"1-3\": \"Container of [cart](doc:cart) properties.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required**\",\n \"1-2\": \"**Required**\",\n \"3-0\": \"`soft-descriptor`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Statement descriptor as it will appear on the credit card bill.\",\n \"5-0\": \"`affiliate-id`\",\n \"5-3\": \"ID number that indicates the affiliate referral.\",\n \"5-2\": \"Optional\",\n \"5-1\": \"*long*\",\n \"2-0\": \"`expected-total-price`\",\n \"2-1\": \"container\",\n \"2-2\": \"**Required**\",\n \"2-3\": \"Container of [expected-total-price](doc:expected-total-price) properties.\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Optional\",\n \"6-0\": \"`seller-order-id`\",\n \"6-3\": \"Merchant's unique ID for the transaction, up to 50 characters.\",\n \"4-0\": \"`descriptor-phone-number`\",\n \"4-1\": \"*string*\",\n \"4-2\": \"Optional\",\n \"4-3\": \"Merchant's support phone number that will appear on the credit card bill. \\n\\nLength: 0-20 characters\",\n \"7-0\": \"`transaction-order-source`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Optional\",\n \"7-3\": \"Identifies the order type.<br />The only option is `MOTO` (**M**ail **O**rder **T**elephone **O**rder). <br />Any other option is ignored.\",\n \"8-0\": \"`store-card`\",\n \"8-1\": \"*boolean*\",\n \"8-2\": \"Optional\",\n \"8-3\": \"Indicate whether the shopper provided permission to store their payment data.\"\n },\n \"cols\": 4,\n \"rows\": 9\n}\n[/block]\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`ordering-shopper`\",\n \"0-1\": \"container\",\n \"h-3\": \"Description\",\n \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"1-0\": \"`cart`\",\n \"1-1\": \"container\",\n \"1-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Container of [ordering-shopper](doc:ordering-shopper) properties.\",\n \"1-2\": \"Container of [cart](doc:cart) properties.\",\n \"2-0\": \"`expected-total-price`\",\n \"2-1\": \"container\",\n \"2-2\": \"Container of [expected-total-price](doc:expected-total-price) properties.\",\n \"3-0\": \"`soft-descriptor`\",\n \"5-0\": \"`affiliate-id`\",\n \"3-1\": \"*string*\",\n \"5-1\": \"*long*\",\n \"3-2\": \"Statement descriptor as it will appear on the credit card bill.\",\n \"5-2\": \"ID number that indicates the affiliate referral.\",\n \"10-0\": \"`seller-order-id`\",\n \"10-1\": \"*string*\",\n \"6-0\": \"`order-id`\",\n \"7-0\": \"`post-sale-info`\",\n \"8-0\": \"`fulfillment`\",\n \"9-0\": \"`transaction-payment-info`\",\n \"6-1\": \"*long*\",\n \"7-1\": \"container\",\n \"8-1\": \"container\",\n \"9-1\": \"container\",\n \"6-2\": \"Order ID.\",\n \"7-2\": \"Container of [post-sale-info](doc:post-sale-info) properties.\",\n \"8-2\": \"Container of [fulfillment](doc:fulfillment) properties.\",\n \"9-2\": \"Container of [transaction-payment-info](doc:transaction-payment-info) properties.\",\n \"10-2\": \"Merchant's unique ID for the transaction\",\n \"4-0\": \"`descriptor-phone-number`\",\n \"4-1\": \"*string*\",\n \"4-2\": \"Merchant's support phone number that will appear on the credit card bill.\"\n },\n \"cols\": 3,\n \"rows\": 11\n}\n[/block]","updates":[],"order":62,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a149","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"6040037678d626005641a08c","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-07-18T14:04:43.848Z","__v":0,"parentDoc":null}order
Property Name
Type
Required
Description
soft-descriptor
string
Optional
Statement descriptor as it will appear on the credit card bill.
descriptor-phone-number
string
Optional
Merchant's support phone number that will appear on the credit card bill.
Length: 0-20 characters
affiliate-id
long
Optional
ID number that indicates the affiliate referral.
seller-order-id
string
Optional
Merchant's unique ID for the transaction, up to 50 characters.
transaction-order-source
string
Optional
Identifies the order type.
The only option is MOTO (Mail Order Telephone Order).
Any other option is ignored.
store-card
boolean
Optional
Indicate whether the shopper provided permission to store their payment data.
Property Name
Type
Description
soft-descriptor
string
Statement descriptor as it will appear on the credit card bill.
descriptor-phone-number
string
Merchant's support phone number that will appear on the credit card bill.
affiliate-id
long
ID number that indicates the affiliate referral.
order-id
long
Order ID.
seller-order-id
string
Merchant's unique ID for the transaction
