Bulk Import of Promo Codes Status

Method Description

Invoked with a POST request. Request address and parameters are set up via Maestra framework.

POST https://api.maestra.io/v3/operations/bulk?endpointId={API endpoint ID}&operation=DirectCrm.PromoCodes.StatusImport&csvCodePage=65001
HTTP/1.1

Authorization: SecretKey {Secret Key}
Accept: application/xml
Content-Type: text/csv
  • csvCodePage: Windows codepage ID for CSV file. 65001 (UTF-8) is preferred.
  • csvColumnDelimiter: Column delimiter symbol in CSV file.
  • csvTextQualifier: Optional start/end character in column value, masking otherwise invalid characters.
  • Authorization key: The value is obtained via Maestra.
  • The service allows up to 60 imports per hour. When this limit is exceeded, you’ll receive 429 Too Many Requests until the ratio of tasks queued/hour drops below 60.

Field Descriptions

TitleDescription
CodePromo code value
CodeTypePromo code type
For example, a promo code for ‘Happy Birthday’ trigger
usedPromo code redemption date in UTC+0. Optional column.
UsedPointOfContactPoint where the promo code was redeemed. Optional column.
active-fromPromo code starting date in UTC+0. Optional column.
expired-atPromo code expiry date in UTC+0. Optional column.

Sample Request

POST https://api.maestra.io/v3/operations/bulk?endpointId=Maestra&operation=DirectCrm.GiftCards.Import&csvCodePage=65001

Authorization: SecretKey VRY294
Accept: application/xml
Content-Type: text/csv

Code;Amount;CodeType;used;UsedPointOfContact
6768953;BirthPromo;18.10.2016 20:02:12;Shop123