Create or upsert vouchers in bulk

POST

https://core.shopimind.com/v1/vouchers

Creates or updates up to 50 vouchers in a single request. Each record is matched on voucher_id: existing vouchers are updated, new ones are created. Vouchers can be assigned to a specific customer_id or be open to any customer. Processing is asynchronous.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Request Body

application/json

[

  

{

  

  

"voucher_id": "promo_2024",

  

  

"shop_id": "shop_id_1",

  

  

"lang": "en",

  

  

"code": "SPM2654",

  

  

"description": "This is a voucher description",

  

  

"started_at": "2023-01-29T14:47:00.000Z",

  

  

"ended_at": "2023-01-29T14:47:00.000Z",

  

  

"customer_id": 10,

  

  

"type_voucher": "amount_reduction",

  

  

"value": 10.99,

  

  

"minimum_amount": 0,

  

  

"currency": "USD",

  

  

"reduction_tax": true,

  

  

"is_used": true,

  

  

"is_active": true,

  

  

"created_at": "2023-01-29T14:47:00.000Z",

  

  

"updated_at": "2023-01-29T14:47:00.000Z"

  

}

]

Responses

Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items.

Content-Type

application/json

{

  

"statusCode": 200,

  

"sent_count": 5,

  

"rejected_count": 0,

  

"rejected_items": [

  

]

}

POST

https://core.shopimind.com/v1/vouchers

Playground

Headers

spm-api-key*

Body

Samples

Create or upsert vouchers in bulk Creates or updates up to 50 vouchers in a single request. Each record is matched on voucher_id: existing vouchers are updated, new ones are created. Vouchers can be assigned to a specific customer_id or be open to any customer. Processing is asynchronous. POST /v1/vouchers bulkCreateVouchers Vouchers spm-api-key [Authentication] Required API key. Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items. All objects are invalid, or the request body is not an array, or the array exceeds the maximum allowed size Server error - Internal processing failure