Class Order

Hierarchy

default
- Order

Index

Constructors

Methods

status spreeResponse classifySpreeError processError processSpreeError spreeOrderHeaders

Properties

Constructors

constructor

new Order(__namedParameters: EndpointOptions): Order
Parameters
- __namedParameters: EndpointOptions
Returns Order

Inherited from Http.constructor

Methods

status

status(options: StatusOptions): Promise<IOrderResult>
Returns a placed Order.

Required token: Order token

Options schema:
```
interface options {
  order_number: string
}
```
Success response schema: Success schema

Failure response schema: Error schema

Example:
```
const response = await client.order.status({
  order_token: '7381273269536713689562374856',
  order_number: 'R653163382'
})
```
Parameters
- options: StatusOptions
Returns Promise<IOrderResult>

`Protected` spreeResponse

spreeResponse<ResponseType>(method: HttpMethod, url: string, tokens?: IToken, params?: any, responseParsing?: ResponseParsing): Promise<ResultResponse<ResponseType>>
Type Parameters
- ResponseType = JsonApiResponse
Parameters
- method: HttpMethod
- url: string
- Optional tokens: IToken
- Optional params: any
- Optional responseParsing: ResponseParsing
Returns Promise<ResultResponse<ResponseType>>

Inherited from Http.spreeResponse

`Protected` classifySpreeError

classifySpreeError(error: default): ErrorType
The HTTP error code returned by Spree is not indicative of its response shape. This function determines the information provided by Spree and uses everything available.
Parameters
- error: default
Returns ErrorType

Inherited from Http.classifySpreeError

`Protected` processError

processError(error: Error): default
Parameters
- error: Error
Returns default

Inherited from Http.processError

`Protected` processSpreeError

processSpreeError(error: default): default
Parameters
- error: default
Returns default

Inherited from Http.processSpreeError

`Protected` spreeOrderHeaders

spreeOrderHeaders(tokens: IToken): {
[headerName: string]: string;
}
Parameters
- tokens: IToken
Returns {
[headerName: string]: string;
}
- [headerName: string]: string
Inherited from Http.spreeOrderHeaders

Properties

fetcher

fetcher: Fetcher

Generated using TypeDoc