Batch API — Smartlinks REST reference

GET

Auth Required

Get a single batch by ID for a collection and product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{collectionId}/batch/{batchId}

Parameters

batchId

path

string

Required

Responses

200

Success

{
  "schema": "BatchResponse"
}

400

Bad request

401

Unauthorized

404

Not found

PUT

Auth Required

Update a batch for a collection and product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{collectionId}/batch/{batchId}

Parameters

batchId

path

string

Required

body

body

BatchUpdateRequest

Required

See BatchUpdateRequest schema

Responses

200

Success

{
  "schema": "BatchResponse"
}

400

Bad request

401

Unauthorized

404

Not found

DELETE

Auth Required

Delete a batch for a collection and product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{collectionId}/batch/{batchId}

Parameters

batchId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

List all batches for a collection and product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/batch

Parameters

productId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

POST

Auth Required

List all batches for a collection and product (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/batch

Parameters

productId

path

string

Required

body

body

BatchCreateRequest

Required

See BatchCreateRequest schema

Responses

200

Success

{
  "schema": "BatchResponse"
}

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

batch.searchInCollection

Endpoint

/admin/collection/{collectionId}/batch

Parameters

collectionId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Find a specific batch by ID across all products in a collection.

Endpoint

/admin/collection/{collectionId}/batch/{batchId}

Parameters

collectionId

path

string

Required

batchId

path

string

Required

Responses

200

Success

{
  "schema": "BatchResponse"
}

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Get all tags/codes assigned to a specific batch.

Endpoint

/admin/collection/{collectionId}/batch/{batchId}/tags

Parameters

collectionId

path

string

Required

batchId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Get serial numbers for a batch (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/batch/{batchId}/getSN

Parameters

collectionId

path

string

Required

productId

path

string

Required

batchId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Look up a serial number by code for a batch (admin only).

Endpoint

/admin/collection/{collectionId}/product/{productId}/batch/{batchId}/lookupSN/{codeId}

Parameters

collectionId

path

string

Required

productId

path

string

Required

batchId

path

string

Required

codeId

path

string

Required

Responses

200

Success

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

Get a single batch by ID for a collection and product (public endpoint).

Endpoint

/public/collection/{collectionId}/product/{collectionId}/batch/{batchId}

Parameters

batchId

path

string

Required

Responses

200

Success

{
  "schema": "BatchResponse"
}

400

Bad request

401

Unauthorized

404

Not found