Create a new order

post

https://api.gratifypay.com/bnpl/2.0/orders

Creates a new order specifying the merchantId, consumerId, and payment method in the request body. Additional order-related fields should also be provided.

Body Params

merchantId

string

required

The merchant that the order is associated with

consumerId

string

required

The consumer that this order is associated with

paymentMethodId

string

required

The payment method token that this order is associated with

storePlatform

string

enum

Platform that this order originated from

price

object

Total price of the order items

priceTaxes

object

Price of taxes or zero if not provided

priceShipping

object

Price of shipping or zero if not provided

pricePromo

object

Price adjustment of promo code or zero if not provided

items

array of objects

required

Array of items in the cart

items*

merchantReferenceId

string

Optional custom ID provided by the merchant on order creation (merchant domain order id)

merchantCustomData

string

Optional custom XML, JSON or similar data provided and managed by the partner API client. Stored with the Gratify Order.

partnerReferenceId

string

Optional data provided by the partner API client as an index or link back to the client-side equivalent model. Stored with the Gratify Order.

partnerCustomData

string

Optional custom XML, JSON or similar data provided and managed by the partner API client. Stored with the Gratify Order.

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Order successfully created

400The request is malformed or input is not valid. Double check your request message body is to specification and try again.

401Unuahtorized access to the Gratify API. Double check your API credentials and try again.

404The specified resource was not found. Double check your URL and version strings try again.

5XXAn unexpected error occurred at the Gratify Server