GET Query
GET /services/data/v51.0/query
Operation ID: Query. Tags: Order. Security: bearerAuth.
To look up information about orders, use the Query resource of the main REST API from Salesforce and set the value of the q parameter to an SOQL query. The following examples are included in the query parameters section of this page, with corresponding examples in the responses section:
Example 1 of 4: listAllOrders
This call allows all orders made to the seller to be listed. If the item limit is exceeded, pagination may be necessary, in which case please refer to the following documentation.
Example 2 of 4: listAllOrdersByCreateDate
This call allows all orders made to the seller to be listed , filtered by order date. If you have more than the permissible number of items, pagination may be necessary, in which case please refer to the following documentation.
Example 3 of 4: listAllOrdersByUpdateDate
This call allows all orders made to the seller to be listed , filtered by order update date. If the item limit is exceeded, pagination may be necessary, in which case please refer to the following documentation.
Example 4 of 4: getOrderByExternalId
This call allows the listing of all order data using the external ID.
Parameters
q(query, string)Example: listAllOrders
SELECT FIELDS(ALL), Atonit_Mktplace__Campaign__r.Id, Atonit_Mktplace__Campaign__r.Atonit_Mktplace__Marketplace_Id__c, Atonit_Mktplace__Campaign__r.Name, (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Line_Items__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Seller_Shipments__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Billed_Tickets__r LIMIT 200) FROM Atonit_Mktplace__Seller_Order__c WHERE Atonit_Mktplace__Seller__r.Atonit_Mktplace__Slug__c= '{{seller-external-id}}' LIMIT 200Example: listAllOrdersByCreateDate
SELECT FIELDS(ALL), Atonit_Mktplace__Campaign__r.Id, Atonit_Mktplace__Campaign__r.Atonit_Mktplace__Marketplace_Id__c, Atonit_Mktplace__Campaign__r.Name, (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Line_Items__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Seller_Shipments__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Billed_Tickets__r LIMIT 200) FROM Atonit_Mktplace__Seller_Order__c WHERE Atonit_Mktplace__Seller__r.Atonit_Mktplace__Slug__c= '{{seller-external-id}}' AND Atonit_Mktplace__Order_Date__c > 2021-04-13T19:25:00.000+00:00 LIMIT 200Example: listAllOrdersByUpdateDate
SELECT FIELDS(ALL), Atonit_Mktplace__Campaign__r.Id, Atonit_Mktplace__Campaign__r.Atonit_Mktplace__Marketplace_Id__c, Atonit_Mktplace__Campaign__r.Name, (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Line_Items__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Seller_Shipments__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Billed_Tickets__r LIMIT 200) FROM Atonit_Mktplace__Seller_Order__c WHERE Atonit_Mktplace__Seller__r.Atonit_Mktplace__Slug__c= '{{seller-external-id}}' AND SystemModstamp > 2021-04-13T19:25:00.000+00:00 LIMIT 200Example: getOrderByExternalId
SELECT FIELDS(ALL), Atonit_Mktplace__Campaign__r.Id, Atonit_Mktplace__Campaign__r.Atonit_Mktplace__Marketplace_Id__c, Atonit_Mktplace__Campaign__r.Name, (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Line_Items__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Seller_Shipments__r LIMIT 200), (SELECT FIELDS(ALL) FROM Atonit_Mktplace__Billed_Tickets__r LIMIT 200) FROM Atonit_Mktplace__Seller_Order__c WHERE Atonit_Mktplace__Seller__r.Atonit_Mktplace__Slug__c='{{seller-external-id}}' AND Atonit_Mktplace__External_Id__c = '00000103-atonit-vitta' LIMIT 200
Responses
- 200
OK
Headers:
Date(string)
Example:Thu, 29 Apr 2021 11:58:14 GMT.Strict-Transport-Security(string)
Example:max-age=31536002; includeSubDomains.X-Content-Type-Options(string)
Example:nosniff.X-XSS-Protection(string)
Example:1; mode=block.X-Robots-Tag(string)
Example:none.Cache-Control(string)
Example:no-cache,must-revalidate,max-age=0,no-store,private.Sforce-Limit-Info(string)
Example:api-usage=1713/101002.Content-Type(string)
Example:application/json;charset=UTF-8.Vary(string)
Example:Accept-Encoding.Content-Encoding(string)
Example:gzip.Transfer-Encoding(string)
Example:chunked.
Media type:
application/json. Schema:object.Example getOrderByExternalId: same as GET /services/data/v51.0/query 200 response.
Example: listAllOrders
{ "totalSize": 2, "done": true, "records": [ { "Atonit_Mktplace__Campaign__r": { "Id": "a0f5Y00000GCTwhQAH", "Atonit_Mktplace__Marketplace_Id__c": "b14d96de-1669-4775-a757-629d1b74a015", "Name": "Campanha de Pré Venda Bombom" }, "Atonit_Mktplace__Line_Items__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0B5Y00000gO1qAUAS", "Name": "LI-0002", "CreatedDate": "2021-04-13T19:27:23.000+0000", "LastModifiedDate": "2021-04-13T19:27:23.000+0000", "Atonit_Mktplace__Discount__c": 1.05, "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta-00000103-00000506-atonit-vitta-0", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Product_Name__c": "Mini Bombom com Banana 60g - Flormel", "Atonit_Mktplace__Product_Variant_Marketplace_Id__c": "at_mini-bombom", "Atonit_Mktplace__Product_Variant__c": "a0L5Y00000o8qTQUAY", "Atonit_Mktplace__Quantity__c": 1, "Atonit_Mktplace__Seller_Shipment__c": "a0R5Y00000Sx7oeUAB", "Atonit_Mktplace__Total_Price__c": 9.49, "Atonit_Mktplace__Unit_Price__c": 10.54 } ] }, "Atonit_Mktplace__Seller_Shipments__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0R5Y00000Sx7oeUAB", "Name": "00000103-00000506-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__External_ID__c": "00000103-00000506-atonit-vitta", "Atonit_Mktplace__Shipping_City__c": "Test City", "Atonit_Mktplace__Shipping_Country__c": "US", "Atonit_Mktplace__Shipping_Method_Marketplace_Id__c": "004", "Atonit_Mktplace__Shipping_Method__c": "Super Saver", "Atonit_Mktplace__Shipping_Rate__c": 1.99, "Atonit_Mktplace__Shipping_State_Province__c": "IL", "Atonit_Mktplace__Shipping_Street__c": "Test Adress", "Atonit_Mktplace__Shipping_Type__c": "Seller", "Atonit_Mktplace__Shipping_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__Custom_Shipment_Note1__c": null, "Atonit_Mktplace__Custom_Shipment_Note2__c": null, "Atonit_Mktplace__Custom_Shipment_Note3__c": null } ] }, "Atonit_Mktplace__Billed_Tickets__r": null, "Id": "a0Q5Y00000UcHjMUAV", "Name": "00000103-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__Billing_City__c": "Test City", "Atonit_Mktplace__Billing_Country__c": "US", "Atonit_Mktplace__Billing_State_Province__c": "IL", "Atonit_Mktplace__Billing_Street__c": "Test Adress", "Atonit_Mktplace__Billing_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Order_Date__c": "2021-04-13T19:26:35.000+0000", "Atonit_Mktplace__Status__c": "Created", "Atonit_Mktplace__Custom_Status__c": "Order Completed", "Atonit_Mktplace__Total_Price__c": 11.48, "Atonit_Mktplace__Total_Shipping_Rate__c": 1.99, "Atonit_Mktplace__Custom_Order_Note1__c": "teste 1", "Atonit_Mktplace__Custom_Order_Note2__c": "teste 2", "Atonit_Mktplace__Custom_Order_Note3__c": "teste 3" }, { "Atonit_Mktplace__Line_Items__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0B5Y00000gO1q5UAC", "Name": "LI-0000", "CreatedDate": "2021-04-13T19:20:40.000+0000", "LastModifiedDate": "2021-04-13T19:21:40.000+0000", "Atonit_Mktplace__Discount__c": 1.05, "Atonit_Mktplace__External_ID__c": "00000101-atonit-vitta-00000101-00000502-atonit-vitta-0", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Product_Name__c": "Mini Bombom com Banana 60g - Flormel", "Atonit_Mktplace__Product_Variant_Marketplace_Id__c": "at_mini-bombom", "Atonit_Mktplace__Product_Variant__c": "a0L5Y00000o8qTQUAY", "Atonit_Mktplace__Quantity__c": 1, "Atonit_Mktplace__Seller_Shipment__c": "a0R5Y00000Sx7oZUAR", "Atonit_Mktplace__Total_Price__c": 9.49, "Atonit_Mktplace__Unit_Price__c": 10.54 } ] }, "Atonit_Mktplace__Seller_Shipments__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0R5Y00000Sx7oZUAR", "Name": "00000101-00000502-atonit-vitta", "CreatedDate": "2021-04-13T19:20:40.000+0000", "LastModifiedDate": "2021-04-13T19:21:40.000+0000", "Atonit_Mktplace__External_ID__c": "00000101-00000502-atonit-vitta", "Atonit_Mktplace__Shipping_City__c": "Test City", "Atonit_Mktplace__Shipping_Country__c": "US", "Atonit_Mktplace__Shipping_Method_Marketplace_Id__c": "004", "Atonit_Mktplace__Shipping_Method__c": "Super Saver", "Atonit_Mktplace__Shipping_Rate__c": 1.99, "Atonit_Mktplace__Shipping_State_Province__c": "IL", "Atonit_Mktplace__Shipping_Street__c": "Test Adress", "Atonit_Mktplace__Shipping_Type__c": "Seller", "Atonit_Mktplace__Shipping_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__Custom_Shipment_Note1__c": null, "Atonit_Mktplace__Custom_Shipment_Note2__c": null, "Atonit_Mktplace__Custom_Shipment_Note3__c": null } ] }, "Atonit_Mktplace__Billed_Tickets__r": { "totalSize": 2, "done": true, "records": [ { "Id": "a0b5Y00000RBaRKQA1", "Name": "101 Atonit Vitta 1", "CreatedDate": "2021-05-28T12:50:54.000+0000", "LastModifiedDate": "2021-05-28T12:50:54.000+0000", "Atonit_Mktplace__Condition__c": "2", "Atonit_Mktplace__DocumentURL__c": "http://www.example.com", "Atonit_Mktplace__Document_Number__c": "43222", "Atonit_Mktplace__Duplicate__c": "1/2", "Atonit_Mktplace__Expiration_Date__c": "2021-08-26", "Atonit_Mktplace__Number__c": "123555", "Atonit_Mktplace__Order_Number__c": "00000101", "Atonit_Mktplace__Seller_Name__c": "Atonit Vitta", "Atonit_Mktplace__Serial_Number__c": "3234324234234", "Atonit_Mktplace__Status__c": "20-Open", "Atonit_Mktplace__Value__c": 34.4, "Atonit_Mktplace__External_Id__c": null }, { "Id": "a0b5Y00000RBZe3QAH", "Name": "101 Atonit Vitta 2", "CreatedDate": "2021-05-24T19:33:11.000+0000", "LastModifiedDate": "2021-05-28T13:32:17.000+0000", "Atonit_Mktplace__Condition__c": "15", "Atonit_Mktplace__DocumentURL__c": "http://www.example.com", "Atonit_Mktplace__Document_Number__c": "43222", "Atonit_Mktplace__Duplicate__c": "1/15", "Atonit_Mktplace__Expiration_Date__c": "2021-05-26", "Atonit_Mktplace__Number__c": "123555", "Atonit_Mktplace__Order_Number__c": "00000101", "Atonit_Mktplace__Seller_Name__c": "Atonit Vitta", "Atonit_Mktplace__Serial_Number__c": "3234324234234", "Atonit_Mktplace__Status__c": "30-Paid", "Atonit_Mktplace__Value__c": 34.4, "Atonit_Mktplace__External_Id__c": null } ] }, "Id": "a0Q5Y00000UcHjHUAV", "Name": "00000101-atonit-vitta", "CreatedDate": "2021-04-13T19:20:40.000+0000", "LastModifiedDate": "2021-04-13T19:21:40.000+0000", "Atonit_Mktplace__Billing_City__c": "Test City", "Atonit_Mktplace__Billing_Country__c": "US", "Atonit_Mktplace__Billing_State_Province__c": "IL", "Atonit_Mktplace__Billing_Street__c": "Test Adress", "Atonit_Mktplace__Billing_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__External_ID__c": "00000101-atonit-vitta", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Order_Date__c": "2021-04-13T19:20:03.000+0000", "Atonit_Mktplace__Status__c": "Created", "Atonit_Mktplace__Custom_Status__c": "Order Completed", "Atonit_Mktplace__Total_Price__c": 11.48, "Atonit_Mktplace__Total_Shipping_Rate__c": 1.99, "Atonit_Mktplace__Custom_Order_Note1__c": "teste order note 1", "Atonit_Mktplace__Custom_Order_Note2__c": "teste order note 2", "Atonit_Mktplace__Custom_Order_Note3__c": "teste order note 3" } ] }Example: listAllOrdersByCreateDate
{ "totalSize": 1, "done": true, "records": [ { "Atonit_Mktplace__Campaign__r": { "Id": "a0f5Y00000GCTwhQAH", "Atonit_Mktplace__Marketplace_Id__c": "b14d96de-1669-4775-a757-629d1b74a015", "Name": "Campanha de Pré Venda Bombom" }, "Atonit_Mktplace__Line_Items__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0B5Y00000gO1qAUAS", "Name": "LI-0002", "CreatedDate": "2021-04-13T19:27:23.000+0000", "LastModifiedDate": "2021-04-13T19:27:23.000+0000", "Atonit_Mktplace__Discount__c": 1.05, "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta-00000103-00000506-atonit-vitta-0", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Product_Name__c": "Mini Bombom com Banana 60g - Flormel", "Atonit_Mktplace__Product_Variant_Marketplace_Id__c": "at_mini-bombom", "Atonit_Mktplace__Product_Variant__c": "a0L5Y00000o8qTQUAY", "Atonit_Mktplace__Quantity__c": 1, "Atonit_Mktplace__Seller_Shipment__c": "a0R5Y00000Sx7oeUAB", "Atonit_Mktplace__Total_Price__c": 9.49, "Atonit_Mktplace__Unit_Price__c": 10.54 } ] }, "Atonit_Mktplace__Seller_Shipments__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0R5Y00000Sx7oeUAB", "Name": "00000103-00000506-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__External_ID__c": "00000103-00000506-atonit-vitta", "Atonit_Mktplace__Shipping_City__c": "Test City", "Atonit_Mktplace__Shipping_Country__c": "US", "Atonit_Mktplace__Shipping_Method_Marketplace_Id__c": "004", "Atonit_Mktplace__Shipping_Method__c": "Super Saver", "Atonit_Mktplace__Shipping_Rate__c": 1.99, "Atonit_Mktplace__Shipping_State_Province__c": "IL", "Atonit_Mktplace__Shipping_Street__c": "Test Adress", "Atonit_Mktplace__Shipping_Type__c": "Seller", "Atonit_Mktplace__Shipping_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__Custom_Shipment_Note1__c": null, "Atonit_Mktplace__Custom_Shipment_Note2__c": null, "Atonit_Mktplace__Custom_Shipment_Note3__c": null } ] }, "Atonit_Mktplace__Billed_Tickets__r": null, "Id": "a0Q5Y00000UcHjMUAV", "Name": "00000103-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__Billing_City__c": "Test City", "Atonit_Mktplace__Billing_Country__c": "US", "Atonit_Mktplace__Billing_State_Province__c": "IL", "Atonit_Mktplace__Billing_Street__c": "Test Adress", "Atonit_Mktplace__Billing_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Order_Date__c": "2021-04-13T19:26:35.000+0000", "Atonit_Mktplace__Status__c": "Created", "Atonit_Mktplace__Custom_Status__c": "Order Completed", "Atonit_Mktplace__Total_Price__c": 11.48, "Atonit_Mktplace__Total_Shipping_Rate__c": 1.99, "Atonit_Mktplace__Custom_Order_Note1__c": "teste 1", "Atonit_Mktplace__Custom_Order_Note2__c": "teste 2", "Atonit_Mktplace__Custom_Order_Note3__c": "teste 3" } ] }Example: listAllOrdersByUpdateDate
{ "totalSize": 1, "done": true, "records": [ { "Atonit_Mktplace__Campaign__r": { "Id": "a0f5Y00000GCTwhQAH", "Atonit_Mktplace__Marketplace_Id__c": "b14d96de-1669-4775-a757-629d1b74a015", "Name": "Campanha de Pré Venda Bombom" }, "Atonit_Mktplace__Line_Items__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0B5Y00000gO1qAUAS", "Name": "LI-0002", "CreatedDate": "2021-04-13T19:27:23.000+0000", "LastModifiedDate": "2021-04-13T19:27:23.000+0000", "Atonit_Mktplace__Discount__c": 1.05, "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta-00000103-00000506-atonit-vitta-0", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Product_Name__c": "Mini Bombom com Banana 60g - Flormel", "Atonit_Mktplace__Product_Variant_Marketplace_Id__c": "at_mini-bombom", "Atonit_Mktplace__Product_Variant__c": "a0L5Y00000o8qTQUAY", "Atonit_Mktplace__Quantity__c": 1, "Atonit_Mktplace__Seller_Shipment__c": "a0R5Y00000Sx7oeUAB", "Atonit_Mktplace__Total_Price__c": 9.49, "Atonit_Mktplace__Unit_Price__c": 10.54 } ] }, "Atonit_Mktplace__Seller_Shipments__r": { "totalSize": 1, "done": true, "records": [ { "Id": "a0R5Y00000Sx7oeUAB", "Name": "00000103-00000506-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__External_ID__c": "00000103-00000506-atonit-vitta", "Atonit_Mktplace__Shipping_City__c": "Test City", "Atonit_Mktplace__Shipping_Country__c": "US", "Atonit_Mktplace__Shipping_Method_Marketplace_Id__c": "004", "Atonit_Mktplace__Shipping_Method__c": "Super Saver", "Atonit_Mktplace__Shipping_Rate__c": 1.99, "Atonit_Mktplace__Shipping_State_Province__c": "IL", "Atonit_Mktplace__Shipping_Street__c": "Test Adress", "Atonit_Mktplace__Shipping_Type__c": "Seller", "Atonit_Mktplace__Shipping_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__Custom_Shipment_Note1__c": null, "Atonit_Mktplace__Custom_Shipment_Note2__c": null, "Atonit_Mktplace__Custom_Shipment_Note3__c": null } ] }, "Atonit_Mktplace__Billed_Tickets__r": null, "Id": "a0Q5Y00000UcHjMUAV", "Name": "00000103-atonit-vitta", "CreatedDate": "2021-04-13T19:27:22.000+0000", "LastModifiedDate": "2021-04-13T19:27:22.000+0000", "SystemModstamp": "2021-04-13T19:27:22.000+0000", "Atonit_Mktplace__Billing_City__c": "Test City", "Atonit_Mktplace__Billing_Country__c": "US", "Atonit_Mktplace__Billing_State_Province__c": "IL", "Atonit_Mktplace__Billing_Street__c": "Test Adress", "Atonit_Mktplace__Billing_Zip_Postal_Code__c": "12345", "Atonit_Mktplace__External_ID__c": "00000103-atonit-vitta", "Atonit_Mktplace__Notes__c": null, "Atonit_Mktplace__Order_Date__c": "2021-04-13T19:26:35.000+0000", "Atonit_Mktplace__Status__c": "Created", "Atonit_Mktplace__Custom_Status__c": "Order Completed", "Atonit_Mktplace__Total_Price__c": 11.48, "Atonit_Mktplace__Total_Shipping_Rate__c": 1.99, "Atonit_Mktplace__Custom_Order_Note1__c": "teste 1", "Atonit_Mktplace__Custom_Order_Note2__c": "teste 2", "Atonit_Mktplace__Custom_Order_Note3__c": "teste 3" } ] }