Create order bump

POST/v1/order-bumps

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description*null|string

status*OrderBumpStatus

Value in

"draft"
"active"
"paused"

productId*string

variantId*string

offerPrice*|

Formatdouble

minimumCartSubtotal*|

Formatdouble

priority*integer

Formatint32

maxPerCart*integer

Formatint32

startsAt*|

Formatdate-time

endsAt*|

Formatdate-time

badgeLabel*null|string

callToAction*null|string

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/v1/order-bumps" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": null,    "status": "draft",    "productId": "string",    "variantId": "string",    "offerPrice": null,    "minimumCartSubtotal": null,    "priority": 0,    "maxPerCart": 0,    "startsAt": null,    "endsAt": null,    "badgeLabel": null,    "callToAction": null  }'

"string"

Create order bump

Authorization

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`