SalesChannelBatchRequests

Get batch request details

get

Returns details of a specific batch request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Batch request details

application/json

404

Batch request not found

application/json

get

/api/v1/channel/{channel_id}/batch_requests/{id}/

GET /api/v1/channel/{channel_id}/batch_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "channel": 1,
  "local_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "created_date": "2026-06-09T05:21:57.573Z",
  "modified_date": "2026-06-09T05:21:57.573Z"
}

Update batch request

put

Updates a batch request with the provided data

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

channelinteger · int64Optional

ID of the channel

remote_batch_idstring · max: 255 · nullableOptional

Remote batch ID

content_typestring · max: 255 · nullableOptional

Content type of the batch request

statusstring · enumOptional

Status of the batch request

Possible values:

log_filestring · nullableOptional

Log file content

Responses

200

Batch request updated successfully

application/json

400

Invalid request data

application/json

404

Batch request not found

application/json

500

Batch request cannot be updated

application/json

put

/api/v1/channel/{channel_id}/batch_requests/{id}/

PUT /api/v1/channel/{channel_id}/batch_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "channel": 1,
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "log_file": "text"
}

{
  "pk": 1,
  "channel": 1,
  "local_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "created_date": "2026-06-09T05:21:57.573Z",
  "modified_date": "2026-06-09T05:21:57.573Z"
}

Delete batch request

delete

Deletes a batch request

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Batch request deleted successfully

No content

404

Batch request not found

application/json

delete

/api/v1/channel/{channel_id}/batch_requests/{id}/

DELETE /api/v1/channel/{channel_id}/batch_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partial update batch request

patch

Partially updates a batch request with the provided data

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

channelinteger · int64Optional

ID of the channel

remote_batch_idstring · max: 255 · nullableOptional

Remote batch ID

content_typestring · max: 255 · nullableOptional

Content type of the batch request

statusstring · enumOptional

Status of the batch request

Possible values:

log_filestring · nullableOptional

Log file content

Responses

200

Batch request updated successfully

application/json

400

Invalid request data

application/json

404

Batch request not found

application/json

500

Batch request cannot be updated

application/json

patch

/api/v1/channel/{channel_id}/batch_requests/{id}/

PATCH /api/v1/channel/{channel_id}/batch_requests/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "channel": 1,
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "log_file": "text"
}

{
  "pk": 1,
  "channel": 1,
  "local_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "created_date": "2026-06-09T05:21:57.573Z",
  "modified_date": "2026-06-09T05:21:57.573Z"
}

List batch requests

get

Returns a list of batch requests for the specified channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

statusstring · enumOptional

Filter by status

Possible values:

content_typestringOptional

Filter by content type

orderingstringOptional

Order by field name

Responses

200

List of batch requests

application/json

404

Channel not found

application/json

get

/api/v1/channel/{channel_id}/batch_requests/

GET /api/v1/channel/{channel_id}/batch_requests/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "channel": 1,
      "local_batch_id": "123e4567-e89b-12d3-a456-426614174000",
      "remote_batch_id": "text",
      "content_type": "text",
      "status": "initialized",
      "objects": [
        {
          "pk": 1,
          "failed_reason_type": "text",
          "remote_id": "text",
          "version_date": "2026-06-09T05:21:57.573Z",
          "content_type": "text"
        }
      ],
      "created_date": "2026-06-09T05:21:57.573Z",
      "modified_date": "2026-06-09T05:21:57.573Z"
    }
  ]
}

Create batch request

post

Creates a new batch request for the specified channel

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

channelinteger · int64Required

ID of the channel

Responses

201

Batch request created successfully

application/json

400

Invalid request data

application/json

404

Channel not found

application/json

post

/api/v1/channel/{channel_id}/batch_requests/

POST /api/v1/channel/{channel_id}/batch_requests/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "channel": 1
}

{
  "pk": 1,
  "channel": 1,
  "local_batch_id": "123e4567-e89b-12d3-a456-426614174000",
  "remote_batch_id": "text",
  "content_type": "text",
  "status": "initialized",
  "objects": [
    {
      "pk": 1,
      "failed_reason_type": "text",
      "remote_id": "text",
      "version_date": "2026-06-09T05:21:57.573Z",
      "content_type": "text"
    }
  ],
  "created_date": "2026-06-09T05:21:57.573Z",
  "modified_date": "2026-06-09T05:21:57.573Z"
}

PreviousSalesChannelOrderShippingInfo NextSalesChannelAddresses

Last updated 5 months ago

Was this helpful?