content.orders.list
GET {{baseUrl}}/content/v2/:merchantId/orders?acknowledged=<boolean>&maxResults=<integer>&orderBy=<string>&pageToken=<string>&placedDateEnd=<string>&placedDateStart=<string>&statuses=<string>&statuses=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists the orders in your Merchant Center account.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
acknowledged | string | Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. | |
maxResults | string | The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. | |
orderBy | string | Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc | |
pageToken | string | The token returned by the previous request. | |
placedDateEnd | string | Obtains orders placed before this date (exclusively), in ISO 8601 format. | |
placedDateStart | string | Obtains orders placed after this date (inclusively), in ISO 8601 format. | |
statuses | string | Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. | |
statuses | string | Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"kind":"exercitation ut dolore","nextPageToken":"dolor velit laborum in","resources":[{"acknowledged":true,"channelType":"fugiat irure","customer":{"email":"minim aliquip","explicitMarketingPreference":false,"fullName":"eiusmod nulla","invoiceReceivingEmail":"est amet magna","marketingRightsInfo":{"explicitMarketingPreference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastUpdatedTimestamp":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"marketingEmailAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"deliveryDetails":{"address":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"phoneNumber":"laboris ad esse exercitation"},"id":"cillum est","kind":"in sunt deserunt ut amet","lineItems":[{"annotations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"cancellations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":"sit commodo esse labore","price":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"product":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"quantityCanceled":-76125299,"quantityDelivered":-91663457,"quantityOrdered":92196255,"quantityPending":86914801,"quantityReadyForPickup":36902305,"quantityReturned":-92418166,"quantityShipped":92244033,"returnInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"returns":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"shippingDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"annotations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"cancellations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":"velit Lorem anim","price":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"product":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"quantityCanceled":63367465,"quantityDelivered":-70893260,"quantityOrdered":91310266,"quantityPending":12124373,"quantityReadyForPickup":98398301,"quantityReturned":-75189524,"quantityShipped":-48475854,"returnInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"returns":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"shippingDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"merchantId":"mollit reprehenderit esse","merchantOrderId":"occaecat ullamco est proident","netAmount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"paymentMethod":{"billingAddress":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"expirationMonth":-35405901,"expirationYear":-47654362,"lastFourDigits":"consequat","phoneNumber":"esse","type":"id Ut dolore"},"paymentStatus":"ea exercitation laborum in","pickupDetails":{"address":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"collectors":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"locationId":"reprehenderit est esse"},"placedDate":"eiusmod","promotions":[{"benefits":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"effectiveDates":"irure proident commodo ex reprehenderit","genericRedemptionCode":"aliquip esse sunt","id":"anim nostrud sed","longTitle":"ea","productApplicability":"ipsum occaecat officia","redemptionChannel":"adipisicing eu aliquip"},{"benefits":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"effectiveDates":"voluptate Excepteur nisi","genericRedemptionCode":"Excepteur eu aliquip","id":"nulla nisi sed minim deserunt","longTitle":"veniam aute","productApplicability":"in","redemptionChannel":"consectetu"}],"refunds":[{"actor":"laboris a","amount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"creationDate":"consequat sint et","reason":"sit aute","reasonText":"veniam dolor amet qui voluptate"},{"actor":"ut cillum est occae","amount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"creationDate":"minim ipsum pariatur magna","reason":"exercitation consectetur aute","reasonText":"exercitation Lorem quis"}],"shipments":[{"carrier":"nulla ex Excepteur","creationDate":"laborum ad cillum qui occaecat","deliveryDate":"sunt occaecat tempor exercitation dolor","id":"culpa exercitation sed amet","lineItems":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"scheduledDeliveryDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":"id Duis adipisicing pariatur","trackingId":"veniam"},{"carrier":"deserunt sint nulla","creationDate":"sint","deliveryDate":"do","id":"ut incididunt","lineItems":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"scheduledDeliveryDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":"cillum velit","trackingId":"in adipisicing culpa enim elit"}],"shippingCost":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"shippingCostTax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"shippingOption":"in dolore ut amet","status":"velit quis nisi","taxCollector":"Excepteur laboris aliquip tempor"},{"acknowledged":false,"channelType":"qui irure","customer":{"email":"aute in","explicitMarketingPreference":true,"fullName":"Ut nisi consequat aliqua elit","invoiceReceivingEmail":"quis amet fugiat","marketingRightsInfo":{"explicitMarketingPreference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastUpdatedTimestamp":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"marketingEmailAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"deliveryDetails":{"address":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"phoneNumber":"dolore minim laboris velit do"},"id":"enim","kind":"tempor dolore","lineItems":[{"annotations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"cancellations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":"anim","price":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"product":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"quantityCanceled":-11370512,"quantityDelivered":-86345674,"quantityOrdered":-17795072,"quantityPending":-52339937,"quantityReadyForPickup":71813315,"quantityReturned":-88610676,"quantityShipped":64915663,"returnInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"returns":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"shippingDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"annotations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"cancellations":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":"dolor ut","price":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"product":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"quantityCanceled":67408260,"quantityDelivered":-67932957,"quantityOrdered":-8080652,"quantityPending":1059611,"quantityReadyForPickup":-4494866,"quantityReturned":38646966,"quantityShipped":-4455447,"returnInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"returns":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"shippingDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"merchantId":"voluptate in adipisicing","merchantOrderId":"labore ut","netAmount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"paymentMethod":{"billingAddress":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"expirationMonth":-67351857,"expirationYear":-57826700,"lastFourDigits":"proident irure non","phoneNumber":"in consequat ipsum sit","type":"nisi sint eu dolor proident"},"paymentStatus":"sit non","pickupDetails":{"address":{"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fullAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPostOfficeBox":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recipientName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"streetAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"collectors":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"locationId":"occaecat amet ut"},"placedDate":"labore","promotions":[{"benefits":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"effectiveDates":"sed et voluptate","genericRedemptionCode":"et ipsum ad pariatur","id":"laborum ut ut offici","longTitle":"dolore non adipisic","productApplicability":"ad","redemptionChannel":"cupidatat nulla minim cillum"},{"benefits":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"effectiveDates":"veniam pariatur in commodo ullamco","genericRedemptionCode":"commodo eiusmod consectetur","id":"adipisici","longTitle":"ali","productApplicability":"ad et","redemptionChannel":"fugiat qui"}],"refunds":[{"actor":"dolore Lorem nisi","amount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"creationDate":"non aliqua dolor dolore reprehenderit","reason":"aute","reasonText":"am"},{"actor":"sunt in ipsum","amount":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"creationDate":"aliquip","reason":"officia fugiat sunt incididunt","reasonText":"veniam ipsum et reprehende"}],"shipments":[{"carrier":"enim quis exercitation","creationDate":"ipsum anim ullamco do","deliveryDate":"sint est Ut esse ex","id":"irure eu labore ex","lineItems":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"scheduledDeliveryDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":"tempor veniam pariatur non","trackingId":"et "},{"carrier":"deserunt id in","creationDate":"elit in","deliveryDate":"officia non Lorem","id":"minim do commodo","lineItems":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"scheduledDeliveryDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":"elit","trackingId":"commodo"}],"shippingCost":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"shippingCostTax":{"currency":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"value":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"shippingOption":"voluptate ad eu Ut","status":"nisi ullamco aute non","taxCollector":"ut elit Lorem of"}]}