BOSS Reporting API

records

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

Retrieve BOSS inventory

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records

Retrieve BOSS handling records for a location.

Retrieve BOSS inventory › query Parameters

option_idstring · uuid
start_datestring · date-time
end_datestring · date-time
pageinteger
page_sizeinteger
orderstring · enum
Set this param to determine the order of records returned. If none provided, defaults to handled_asc: record handled_at in ascending order.
Enum values:
handled_asc
handled_desc
updated_desc
updated_asc
created_desc
created_asc

Retrieve BOSS inventory › 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.

Retrieve BOSS inventory › Responses

resultsobject[]
paginationobject

Create new handling record

POST

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records

Create a new BOSS handling record for a location.

Create new handling record › 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 new handling record › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Create new handling record › Responses

Created

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Retrieve existing handling record

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Retrieve information on an existing BOSS handling record.

Retrieve existing handling record › 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.

Retrieve existing handling record › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Edit existing handling record

PUT

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Update (full or partial) information on an existing BOSS handling record (identical to PATCH)

Edit existing handling record › 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.

Edit existing handling record › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Edit existing handling record › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Delete existing handling record

DELETE

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Delete an existing BOSS handling record.

Delete existing handling record › 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.

Delete existing handling record › Responses

No Content

No data returned

Edit existing handling record (same as PUT)

PATCH

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Update (full or partial) information on an existing BOSS handling record (identical to PUT)

Edit existing handling record (same as PUT) › 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.

Edit existing handling record (same as PUT) › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Edit existing handling record (same as PUT) › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Retrieve container contents

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/containers/{container_id}/records

Get all records of sorted products from a container

Retrieve container contents › query Parameters

pageinteger

Retrieve container contents › 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.

Retrieve container contents › Responses

resultsobject[]
paginationobject

Add a product to a container

POST

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/containers/{container_id}/records

Add a product to a container

Add a product to a container › 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.

Add a product to a container › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Add a product to a container › Responses

Created

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

status containers

BOSS Reporting API

records

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

Retrieve BOSS inventory

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records

Retrieve BOSS handling records for a location.

Retrieve BOSS inventory › query Parameters

option_idstring · uuid
start_datestring · date-time
end_datestring · date-time
pageinteger
page_sizeinteger
orderstring · enum
Set this param to determine the order of records returned. If none provided, defaults to handled_asc: record handled_at in ascending order.
Enum values:
handled_asc
handled_desc
updated_desc
updated_asc
created_desc
created_asc

Retrieve BOSS inventory › 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.

Retrieve BOSS inventory › Responses

resultsobject[]
paginationobject

Create new handling record

POST

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records

Create a new BOSS handling record for a location.

Create new handling record › 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 new handling record › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Create new handling record › Responses

Created

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Retrieve existing handling record

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Retrieve information on an existing BOSS handling record.

Retrieve existing handling record › 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.

Retrieve existing handling record › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Edit existing handling record

PUT

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Update (full or partial) information on an existing BOSS handling record (identical to PATCH)

Edit existing handling record › 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.

Edit existing handling record › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Edit existing handling record › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Delete existing handling record

DELETE

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Delete an existing BOSS handling record.

Delete existing handling record › 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.

Delete existing handling record › Responses

No Content

No data returned

Edit existing handling record (same as PUT)

PATCH

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/records/{record_id}

Update (full or partial) information on an existing BOSS handling record (identical to PUT)

Edit existing handling record (same as PUT) › 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.

Edit existing handling record (same as PUT) › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Edit existing handling record (same as PUT) › Responses

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

Retrieve container contents

GET

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/containers/{container_id}/records

Get all records of sorted products from a container

Retrieve container contents › query Parameters

pageinteger

Retrieve container contents › 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.

Retrieve container contents › Responses

resultsobject[]
paginationobject

Add a product to a container

POST

https://boss-test.smarterx.com

/v1/boss/reporting/{location_external_id}/containers/{container_id}/records

Add a product to a container

Add a product to a container › 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.

Add a product to a container › Request Body

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.

Add a product to a container › Responses

Created

product_idstring · uuid · required
Smarter Sorting id of the product that was handled
option_idstring · uuid · required
Smarter Sorting id of the handling option that was selected
handled_atstring · date-time · required
The time at which the product was handled
quantitynumber · min: 1 · required
Quantity of the product handled

idstring · uuid · readOnly
uuid of the handling record

Read-only. Do NOT include in POST requests
gtinstring · pattern: ^[0-9]{8,14}$
GTIN of the product if available. Ignored if provided in a request body.

8, 12, 13, or 14 digits in length
Example: 00757037351253
skustring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345
external_idstring · maxLength: 128 · pattern: ^[A-Za-z0-9-_]+$
Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345
recommendation_idstring · uuid
Smarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0
Real world measured weight of a single unit of the product

Precision: at least 6 decimal places

Total weight is reported as weight * quantity
weight_measured_instring · enum
Unit of measure for weight. Required if weight is provided.
Enum values:
lbs
g
kg
Example: lbs
metadataobject
Object containing additional string metadata about a product as key value pairs.

Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstring
Name or identifier of the user who handled the product
Example: John Doe
container_idstring · uuid
Smarter Sorting id of the container that the product is placed in.
product_namestring
Products name
Example: Incredible Hand Soap

status containers