{"_id":"5adf4e5bac13b80003d231d3","category":{"_id":"5adf4e59ac13b80003d2315b","version":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5adf4e59ac13b80003d23153","5adf4e59ac13b80003d23154","5adf4e59ac13b80003d23155","5adf4e59ac13b80003d23156","5adf4e59ac13b80003d23157","5adf4e59ac13b80003d23158","5adf4e59ac13b80003d23159","5adf4e59ac13b80003d2315a","5adf4e59ac13b80003d2315b","5adf4e59ac13b80003d2315c","5adf4e59ac13b80003d2315d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-27T17:11:27.535Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":102,"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  },\n  \"cols\": 4,\n  \"rows\": 7\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]","excerpt":"","slug":"order","type":"basic","title":"order"}

Request

Property Name
Type
Required
Description

ordering-shopper

container

Required

Container of ordering-shopper properties.

cart

container

Required

Container of cart properties.

expected-total-price

container

Required

Container of expected-total-price properties.

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.

Response

Property Name
Type
Description

ordering-shopper

container

Container of ordering-shopper properties.

cart

container

Container of cart properties.

expected-total-price

container

Container of expected-total-price properties.

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.

post-sale-info

container

Container of post-sale-info properties.

fulfillment

container

Container of fulfillment properties.

transaction-payment-info

container

Container of transaction-payment-info properties.

seller-order-id

string

Merchant's unique ID for the transaction