/order/{orderId}/confirm

post

https://api.us.zip.co/order/{orderId}/confirm

Confirms an order with a possibly increased order total, to account for taxes and shipping

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orderId

string

required

Id of the order to be confirmed

Body Params

Amount

double

Defaults to null

Updated order total if the order's final total is greater than the original. If provided and higher than the order amount, will be redistributed across customer's payment plan. If not provided, will assume same amount as on order creation.

ShippingAmount

double

Defaults to null

If provided, will update the order's shipping amount to this value.

TaxAmount

double

Defaults to null

If provided, will update the order's tax amount.

MerchantReference

string

Required - Indicates the unique merchant identifier for this operation

CallbackUrl

string

If provided, will issue a webhook updating this endpoint after order confirmation has completed.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

text/plain

200200

400400