Skip to main content
API docs by Redocly

External Order API (v0)

Download OpenAPI specification:Download

Retrieve orders associated with the customer by the external customer ID

Retrieves a paginated list of all orders associated with the customer for the external customer ID.

Authorizations:
newStoreAccessToken
path Parameters
id
required
string

The identifier for the customer in the external system. For example, the customer ID in Shopify.

Responses

Response samples

Content type
application/json
{
  • "pagination_info": {},
  • "items": [
    ]
}

Retrieve all orders for a customer email address Deprecated

Retrieves all orders for a customer email address.

Use the GET: /consumer_profiles method with ?q=jay.doe@example.com, to retrieve the customer's id. Note that based on your query, multiple results may be returned. Use the GET: /consumer_profiles/{id}/orders method to get orders for the customer.

Authorizations:
newStoreAccessToken
path Parameters
email
required
string

The email address of the customer.

Responses

Response samples

Content type
application/json
{
  • "pagination_info": {},
  • "items": [
    ]
}

Retrieve orders associated with the order ID

Retrieves the order associated with the provided order ID. The ID can be internal to NewStore or external.

Authorizations:
newStoreAccessToken
path Parameters
type
required
string
Default: "external_id="

The type of the identifier for the order.

Use id= to use the NewStore Omnichannel Cloud ID, or external_id= to use an external ID.

id
required
string

The identifier for the order either inside NewStore Omnichannel Cloud (id) or in an external system such as Shopify.

Responses

Response samples

Content type
application/json
{
  • "address_changed": false,
  • "billing_address": {
    },
  • "channel": "NewStore Associate App",
  • "channel_type": "web",
  • "created_at": "2018-03-07T14:07:20.512773Z",
  • "created_by_label": "",
  • "customer_uuid": "d4d178f2-bfa4-4c00-9a93-8807c1af4448",
  • "external_customer_id": "",
  • "external_order_id": "GD000009658",
  • "order_id": "GD000009658",
  • "order_uuid": "88a4aa63-71f3-40b2-a1e1-dc71611d0395",
  • "ordered_products": [
    ],
  • "payments": [
    ],
  • "revision": 8,
  • "shipments": [
    ],
  • "shipping_address": {
    },
  • "status_description": "",
  • "status_label": "Delivered",
  • "taxation": "gross",
  • "totals": {
    }
}