Developer Documentation
Developer Documentation
Home
PartPay
get

/order

Retrieves an individual order by token

Deprecated

Avoid using this API operation if possible. It will be removed in a future version.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Query 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
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.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token