Qodex.ai

GET tenant-salesorders

GET {{baseUrl}}/order-v2/{{tenant}}/salesorders?pageNumber=1&pageSize=16

Retrieves created orders, as a merchant, for administrative purposes.

Requires scope order.order_read.

Request Params

KeyDatatypeRequiredDescription
sortnullThe list of comma-separated properties used to sort the results.
By default, the column values are sorted in ascending order.
Can either be in the form of fieldName or fieldName:asc,fieldName:desc.
If you want to sort by localized attributes, you must use the following form:
fieldName.language or fieldName.language:asc,fieldName.language:desc.
pageNumbernumberThe page number to be retrieved where the size of the pages must be specified by the pageSize parameter.
The number of the first page is 1.
pageSizenumberThe number of documents being retrieved on the page.

HEADERS

KeyDatatypeRequiredDescription
saas-tokennull(Required) Token used to identify loggedin users. This token has an expiery date and is signed with a passphrase.

RESPONSES

status: OK

[{"id":"orderId123456","metadata":{"mixins":{"additionalCode":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"}},"mixins":{"additionalCode":{"code":"DFG-334-98330-X"}},"created":"2014-03-31T10:18:21.134Z","completed":"2014-04-15T10:18:21.134Z","status":"COMPLETED","siteCode":"Germany","countryCode":"DE","deliveryWindowId":"5d230f973f05e303d5c30dba","orderCycle":"2014-04-12T14:00:00.000Z","channel":{"name":"Pinterest","source":"https://www.pinterest.com/pin/123456"},"entries":[{"id":"5c13ccdbba93e00008b8d274","amount":2,"orderedAmount":2,"originalAmount":450,"originalPrice":450,"unitPrice":420,"totalPrice":840,"authorizedAmount":840,"link":"https://api.emporix.io/product/saasdev2/products/5c13ccdbba93e00008b8d274","product":{"description":"A mug you've always wanted !","name":"Mug","sku":"mug-product","published":true,"images":[{"id":"media123456","url":"https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"}]},"variant":{"id":"438954845899094","name":"Black Small Mug","code":"mug-black-small","images":[{"id":"12345678","url":"https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"}],"options":{"mug":{"color":"black","size":"small"}},"mixins":{"additionalVariantCode":{"code":"variant code"}}}},{"id":"1234547","amount":5,"orderedAmount":5,"originalAmount":250,"originalPrice":450,"unitPrice":240,"totalPrice":1200,"authorizedAmount":1200,"product":{"metadata":{"mixins":{"color":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/color_v1.json"}},"description":"A Shirt you've always wanted !","name":"Shirt","sku":"shirt-product","published":true,"images":[{"id":"media1234567","url":"https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"}],"mixins":{"color":{"red":234,"green":231,"blue":123}}},"variant":{"id":"968954845899234","name":"Black Small T-Shirt","code":"t-shirt-black-small","images":[{"id":"12345679","url":"https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"}],"options":{"tshirt":{"color":"black","size":"small"}},"mixins":{"additionalVariantCode":{"code":"variant code"}}}}],"discounts":[{"code":"SUMMER_SALE","name":"Summer Sale 10% off everything","amount":204,"currency":"USD","discountRate":10,"sequenceId":1,"link":{"id":"B2TD3JM","type":"y-coupon","url":"https://api.emporix.io/coupon/saasdev2/coupons/ENG2OC"}}],"customer":{"id":"C1234567890","title":"Dr.","name":"Example Buyer","firstName":"Example","lastName":"Buyer","email":"noreply@emporix.com","company":"emporix"},"billingAddress":{"contactName":"Example Buyer","street":"Nymphenburger Str.","streetNumber":"86","city":"Munich","state":"Bavaria","country":"Germany","zipCode":"132 45","contactPhone":"+49 1111 222 333"},"shippingAddress":{"contactName":"Joe Smith","companyName":"Cargo Services Airfreight","street":"Cheng Xiang Zhen Guan Tang Lu","streetNumber":"1031","extraLine1":"No. 2058","extraLine2":"Suzhou City","zipCode":"201202","city":"Taicang City","state":"Jiangsu Province","country":"CN","contactPhone":"+86 182 9349 4663","metadata":{"mixins":{"secondaryContactPhone":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"}},"mixins":{"secondaryContactPhone":{"number":"+86 334 0033 9934"}}},"subTotalPrice":1881,"totalPrice":2041,"totalAuthorizedAmount":2041,"currency":"USD","payments":[{"status":"SUCCESS","method":"STRIPE","paymentResponse":"","paidAmount":2041,"currency":"USD"}],"tax":{"total":{"amount":150,"currency":"USD"},"lines":[{"amount":150,"currency":"USD","code":"VAT","name":"Regular VAT","rate":10,"taxable":1500,"sequenceId":1,"inclusive":false}]},"shipping":{"total":{"amount":10,"currency":"USD"},"lines":[{"amount":10,"currency":"USD","code":"dhlstd","name":"DHL Standard"}]},"shipments":[{"trackingNumber":"123987456","carrier":"UPS","shippedDate":"2016-06-25T16:22:52.966Z","expectDeliveryOn":"2016-06-27"}]},{"id":"orderId123457","created":"2015-02-11T03:12:33.345Z","status":"CREATED","deliveryWindowId":"5d230f973f05e303d5c30dba","siteCode":"Germany","countryCode":"DE","channel":{"name":"Twitter","source":"https://twitter.com/emporix/status/707599225782214656"},"entries":[{"metadata":{"mixins":{"additionalCode":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"}},"id":"5c13ccdbba93e00008b8d274","amount":1,"unitPrice":420,"totalPrice":420,"authorizedAmount":420,"link":"https://api.emporix.io/product/saasdev2/products/5c13ccdbba93e00008b8d274","product":{"description":"A mug you've always wanted !","name":"Mug","sku":"mug-product","published":true,"images":[{"id":"media123456","url":"https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"}]},"mixins":{"additionalCode":{"code":"ABC"}}}],"customer":{"id":"C1234567890","title":"Dr.","name":"Example Buyer","firstName":"Example","lastName":"Buyer","email":"noreply@emporix.com","company":"emporix","metadata":{"mixins":{"work_phone":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"}},"mixins":{"work_phone":{"number":"+86 334 0033 9934"}}},"billingAddress":{"contactName":"Example Buyer","street":"Nymphenburger Str.","streetNumber":"86","city":"Munich","state":"Bavaria","country":"DE","zipCode":"132 45","contactPhone":"+49 1111 222 333"},"shippingAddress":{"contactName":"Joe Smith","companyName":"Cargo Services Airfreight","street":"Cheng Xiang Zhen Guan Tang Lu","streetNumber":"1031","extraLine1":"No. 2058","extraLine2":"Suzhou City","zipCode":"201202","city":"Taicang City","state":"Jiangsu Province","country":"CN","contactPhone":"+86 182 9349 4663","metadata":{"mixins":{"secondaryContactPhone":"https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"}},"mixins":{"secondaryContactPhone":{"number":"+86 334 0033 9934"}}},"totalPrice":420,"totalAuthorizedAmount":420,"currency":"USD"}]