BOSS Unknown Items API

Schemas

ErrorMessages

error_messagesstring[]

BaseImageData

namestring
Descriptive name of image
filenamestring
File name
content_typestring
MIME type for image file (must be JPEG or PNG)

URLImageData

namestring
Descriptive name of image
filenamestring
File name
content_typestring
MIME type for image file (must be JPEG or PNG)
urlstring · uri
URL for image, must not require authentication

Base64ImageData

namestring
Descriptive name of image
filenamestring
File name
content_typestring
MIME type for image file (must be JPEG or PNG)
datastring · base64
Base64-encoded image data

UnknownItemsRequest

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)

Option

idstring · uuid
namestring

EligibleRecommendationCategory

categorystring · enum
Option Category
Enum values:
disposal
donation
organics
recycle
vendor_managed
eligibleboolean
Always true for eligible categories
optionsobject[]

IneligibleRecommendationCategory

categorystring · enum
Option Category
Enum values:
disposal
donation
organics
recycle
vendor_managed
eligibleboolean
Always false for ineligible categories

RecommendationsList

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

categorystring · enum
Option Category
Enum values:
disposal
donation
organics
recycle
vendor_managed
eligibleboolean
Always true for eligible categories
optionsobject[]

CallbackResult

status_codeinteger
HTTP response status from POST
startedstring · date-time
When the POST was started
finishedstring · date-time
When the POST was completed
error_messagesstring[]
Error messages

RequestState

string · enum

Enum values:

SUBMITTED

REGISTERED

UPDATES_NEEDED

COMPLETE

WASTE_HAULER

Request state

ProductResponse

product_idstring · uuid
Identifier to use with boss-reporting-api
namestring
Product name
sds_urlstring · uri
URL for SDS
recommendationsarray

SingleComponentResponse

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)

MultiComponentResponse

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)
componentsobject[]

Pagination

pageinteger
1-indexed page number
total_pagesinteger
total number of pages
total_resultsinteger
total number of results

RecommendationsList

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

categorystring · enum
Option Category
Enum values:
disposal
donation
organics
recycle
vendor_managed
eligibleboolean
Always true for eligible categories
optionsobject[]

SingleComponentResponse

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)

MultiComponentResponse

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)
componentsobject[]