Skip to main content
object

This acts as the public, top-level API from which all queries start.

•Company

The information of the customer's company. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Arguments

•ID!
required

The ID of the Company.


•CompanyLocation

The Location corresponding to the provided ID. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Arguments

•ID!
required

The ID of the Location.


•Customer!
non-null

Returns the Customer resource. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields
•DraftOrder

Returns a draft order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Arguments

•ID!
required

The ID of the draft order to be returned.


•Order

Returns an Order resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Arguments

•ID!
required

The ID of the Order to return.


Anchor to requestedOrderEditCalculaterequestedOrderEditCalculate
•CalculatedRequestedOrderEdit

The calculated financial outcome of a requested order edit.

Show fields

Arguments

•CalculateRequestedOrderEditInput!
required

The input fields for calculating a requested order edit.

Show input fields

•Return

Returns a Return resource by ID. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Arguments

•ID!
required

The ID of the Return.


•CalculatedReturn

The calculated monetary value of the return.

Show fields

Arguments

•CalculateReturnInput!
required

The input fields for calculating a return.

Show input fields

•Shop!
non-null

Returns the information about the shop. Apps using the Customer Account API must meet the protected customer data requirements.

Show fields

Was this section helpful?