Endpoint: https://api.omnisend.com/v3/batches

Batch operations are used to make multiple one type operations with one request.

Currently supported:

  • POST batch operations for: contacts, products, orders, events (only trigger by eventID), categories
  • PUT batch operations for: products, orders (don't forget to add productID or orderID in each item array object)

Operations limit in one batch - 1000.

Batch statuses

StatusDescription
pendingBatch is received but not started
inProgressBatch is in progress
finishedAll batch operations are finished
stoppedBatch stopped for too many errors

Parameters

ParameterTypeDescription
methodstringSupported methods: POST
endpointstringEndpoint: contacts, orders, products, events
eventIDstringEventID is required and used only with endpoint events
batchIDstringBatch ID. You can use this ID for checking batch status and errors.
statusstringBatch status
createdAtstring (format: date-time)Batch creation date-time. ISO 8601 format. Example: 2017-05-30T15:14:22Z
startedAtstring (format:date-time)Batch operations start time. ISO 8601 format. Example: 2017-05-30T15:14:22Z
endedAtstring (format:date-time)Batch operations finish time. ISO 8601 format. Example: 2017-05-30T15:14:22Z
totalCountintegerItems in batch count
finishedCountintegerProcessed items in batch count
errorsCountintegerItems with errors in batch count
errorsarrayError array
responsesarrayResponses of successfully finished operations
responsearrayResult of operation (Json format)
responseCodeintegerResponse code
itemsarrayParameters array. Use same parameters as using in defined method.
items.itemIDstringBatch each item's ID. You can use it to check specific batch item response or status.
requestarrayRequest array (Json format)
items.statusstringCan be: pending, finished