Batch Downloading

Batch Downloading

Starts the process of downloading batches

Starts the process of downloading batches

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The batch downloading that you would like to be saved.

business_unit_id
required
string (Business Unit)

The business unit

batch_ids
required
Array of strings (Batches) non-empty

The IDs of the batches to download

Responses
200The batch downloading was initiated successfully
400The batch downloading record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The batch downloading could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch downloading based on tenant limits.
500General server error
post/batchDownloading/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "business_unit_id": "string",
  • "batch_ids": [
    ]
}
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Allows for previewing batch template

Starts the process of downloading batches

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The batch template

file_name_template
required
string (File Name Template)
template
required
string (Template)
Responses
200The batch downloading was initiated successfully
400The batch downloading record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The batch downloading could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch downloading based on tenant limits.
500General server error
post/batchDownloading/{tenantId}/preview
Request samples
    1 more
    Python
application/json
{
  • "file_name_template": "string",
  • "template": "string"
}
Response samples
application/json
"string"

Initiates workflow to warm up inventory transactions

Request
Security:
knox-authorizer
Responses
200Success
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
post/batchDownloading/warmUpStepFunctions
Request samples
curl -i -X POST \
  https://collect.api.756794052567.rhythmsoftware.com/batchDownloading/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'