BOSS APIs Developer Portal (Smarter Sorting)

BOSS Unknown Items API

Endpoint:https://boss-test.smarterx.com

Get all unknown item requests for a location

GET

https://boss-test.smarterx.com

/v1/unknown/locations/{location_id}/requests

Get all unknown item requests for a location › path Parameters

location_idstring · required
Location name

Get all unknown item requests for a location › query Parameters

start_datestring · date-time
Start of time range for requests to return. Defaults to 24 hours ago.
end_datestring · date-time
End of time range for requests to return. Defaults to right now.
pageinteger
1-indexed page number (defaults to 1)
page_sizeinteger
page size (defaults to 10)

Get all unknown item requests for a location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get all unknown item requests for a location › Responses

Request statuses for a location

resultsarray
paginationobject
Pagination info

Create a new unknown item request

POST

https://boss-test.smarterx.com

/v1/unknown/locations/{location_id}/requests

Create a new unknown item request › path Parameters

location_idstring · required
Location name

Create a new unknown item request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new unknown item request › Request Body

imagesarray · required

skustring
SKU
external_idstring
Custom retailer identifier
gtinstring · pattern: ^([0-9]{8}|[0-9]{12,…
callback_urlstring · uri
Provide this to receive results via webhook (POST to this URL)

Create a new unknown item request › Responses

Current state of the request, and any available recommendations

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Get the status and results for a submitted request

GET

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

This endpoint may be polled to get the status of the request.

Please refrain from polling at a frequency greater than six times per minute.

Get the status and results for a submitted request › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Get the status and results for a submitted request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get the status and results for a submitted request › Responses

Current state of the request, and any available recommendations

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Update a request, e.g. to submit new images

PUT

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

Use this endpoint to update an existing request. The request state will change back to SUBMITTED.

Modifying a request in one of the following states is not allowed:

COMPLETE
WASTE_HAULER
REGISTERED

Update a request, e.g. to submit new images › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Update a request, e.g. to submit new images › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a request, e.g. to submit new images › Responses

An updated request that's returned to the SUBMITTED state

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Cancel a pending unknown items request

DELETE

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

Cancels an in-progress request.

Cancelling a request in one of the following states is not allowed:

COMPLETE
WASTE_HAULER
REGISTERED

Cancel a pending unknown items request › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Cancel a pending unknown items request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel a pending unknown items request › Responses

Success (no data)

No data returned

Get all unknown item requests for a location

GET

https://boss-test.smarterx.com

/v1/unknown/locations/{location_id}/requests

Get all unknown item requests for a location › path Parameters

location_idstring · required
Location name

Get all unknown item requests for a location › query Parameters

start_datestring · date-time
Start of time range for requests to return. Defaults to 24 hours ago.
end_datestring · date-time
End of time range for requests to return. Defaults to right now.
pageinteger
1-indexed page number (defaults to 1)
page_sizeinteger
page size (defaults to 10)

Get all unknown item requests for a location › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get all unknown item requests for a location › Responses

Request statuses for a location

resultsarray
paginationobject
Pagination info

Create a new unknown item request

POST

https://boss-test.smarterx.com

/v1/unknown/locations/{location_id}/requests

Create a new unknown item request › path Parameters

location_idstring · required
Location name

Create a new unknown item request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new unknown item request › Request Body

imagesarray · required

skustring
SKU
external_idstring
Custom retailer identifier
gtinstring · pattern: ^([0-9]{8}|[0-9]{12,…
callback_urlstring · uri
Provide this to receive results via webhook (POST to this URL)

Create a new unknown item request › Responses

Current state of the request, and any available recommendations

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Get the status and results for a submitted request

GET

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

This endpoint may be polled to get the status of the request.

Please refrain from polling at a frequency greater than six times per minute.

Get the status and results for a submitted request › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Get the status and results for a submitted request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get the status and results for a submitted request › Responses

Current state of the request, and any available recommendations

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Update a request, e.g. to submit new images

PUT

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

Use this endpoint to update an existing request. The request state will change back to SUBMITTED.

Modifying a request in one of the following states is not allowed:

COMPLETE
WASTE_HAULER
REGISTERED

Update a request, e.g. to submit new images › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Update a request, e.g. to submit new images › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a request, e.g. to submit new images › Responses

An updated request that's returned to the SUBMITTED state

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray
idstring · uuid
UUID for this unknown item request
statestring · enum
Request state
Enum values:
SUBMITTED
REGISTERED
UPDATES_NEEDED
COMPLETE
WASTE_HAULER
created_onstring · date-time
updated_onstring · date-time
messagesobject[]
callback_urlstring · uri
Callback (webhook) destination, may be null if polling
callback_resultsobject[]
Results of attempts to POST the webhook (may be retried)

Cancel a pending unknown items request

DELETE

https://boss-test.smarterx.com

/v1/unknown/requests/{request_id}

Cancels an in-progress request.

Cancelling a request in one of the following states is not allowed:

COMPLETE
WASTE_HAULER
REGISTERED

Cancel a pending unknown items request › path Parameters

request_idstring · uuid · required
Request ID (UUID)

Cancel a pending unknown items request › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel a pending unknown items request › Responses

Success (no data)

No data returned