Developer Documentation
Developer Documentation
Home
Zip
get

/order/{id}

Retrieves an individual order by Order Id.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

OK

Schema
object
orderId
string

OrderId that uniquely identifies an order

1 validation
orderNumber
string

Identifies an order but smaller and more readable than the OrderId.

orderStatus
string

Gets the order Status from payment perspective.

1 validation + required
amount
number

Amount for order to be charged to consumer.

1 validation + required
consumer
object

The consumer requesting the order.

billing
object
shipping
object
description
string

A description of the order. Is optional if items array is populated

items
array[object]

An array of order items.

merchant
object
merchantReference
string

The merchant’s id/reference that this order corresponds to.

taxAmount
number

The included tax amount after applying all discounts.

1 validation
shippingAmount
number

The shipping amount.

1 validation
token
string

The order token.

promotions
array[string]

The promotion(s) for the order.

capturedAmount
number

Returns the amount that has been captured against the order. If the order has been created with paymentType of auth, then this will increment with each request to the capturepayment endpoint. If the order is created with a (default) paymentType of payment then this will increment once the customer has completed checkout

refundedAmount
number

The total of all refund amounts made against the order.

createdDateTime
string

The UTC timestamp of when the order was first created. In ISO8601 format. I.e. 2018-05-07T05:44:17.95Z

1 validation
redirectUrl
string

The redirectUrl to return the customer to, so they can complete their Zip order

required
metadata
object

Object containing name value pairs of meta data to be returned whenever recalling this checkout object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
region-lower
oauth_access_token