v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

ORDERS

Apply a service charge to an order

Request body must include the merchant's service charge ID. This ID can be retrieved from /v3/merchants/mId/default_service_charge. Each request can set a different name and percentageDecimal as needed for an order.

post/v3/merchants/{mId}/orders/{orderId}/service_charge/

Path parameters

mIdstring required

Merchant Id

orderIdstring required

Order Id

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

idstring

Unique identifier

namestring

Service charge name

enabledboolean

Indicates if this service charge is enabled.

percentageinteger

Deprecated use percentage decimal instead.

percentageDecimalinteger

Percent to charge times 10000, for example, 12.5% will be 125000.

isAutoAppliedboolean

Indicates service charge was auto applied or not.