Class: module:api/OrdersApi

module:api/OrdersApi(apiClient)

new module:api/OrdersApi(apiClient)

Constructs a new OrdersApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

getOrder(code, opts) → {Promise}

getOrder Returns details of a specific order based on order GUID (Globally Unique Identifier) or order CODE. The response contains a detailed order information. Security: Allowed only for trusted client

Parameters:
Name Type Description
code String

Order GUID (Globally Unique Identifier) or order CODE
opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with data of type module:models/Order

Type
Promise

ordersByCodeWithHttpInfo(code, opts) → {Promise}

getOrder Returns details of a specific order based on order GUID (Globally Unique Identifier) or order CODE. The response contains a detailed order information. Security: Allowed only for trusted client

Parameters:
Name Type Description
code String

Order GUID (Globally Unique Identifier) or order CODE
opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)
Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Order and HTTP response

Type
Promise