External Bin Changes (2023-05-01 r1)

Download OpenAPI specification:Download

This is a unified, external API for unit and location bin changes.

Perform a bin-change for a unit or a location.

Performs a bin-change for a unit (identified by its LP) or a location (identified by its name). This will move the unit/location from its current location into another location.

Securityoptoro_auth
Request
header Parameters
Optiturn-External-Bin-Changes-Version
required
string

Version of the External Bin Changes API

Value: "2023-05-01"
Request Body schema: application/json
One of:
id
string

LP of a unit

location_id
string

Name of a location

Responses
201

The bin-change was performed successfully.

400

The server cannot process the request due to a client error. Check the message and detail fields for further information.

401

Missing, expired, or invalid OAuth bearer token. Request a new token from the auth service.

500

An internal error occured. Please contact Optoro for further guidance.

503

Service is unavailable and/or over capacity. Please try again later.

504

Service is over capacity. Please try again later.

post/external_bin_changes
Request samples
application/json

Moves unit LPCN786457 from its current location to CA-TN-0001.

{
  • "location_id": "CA-TN-0001",
  • "id": "LPCN786457"
}
Response samples
application/json

Moved unit LPCN786457 to CA-TN-0001.

{
  • "location_id": "CA-TN-0001",
  • "id": "LPCN786457"
}

Show information that is relevant for bin-changing of a unit or location.

Shows unit-level and location-level information of the item that should be bin-changed, most importantly information about the directed sorting zone and slot for units.

Securityoptoro_auth
Request
path Parameters
required
string or string

The identifier of a unit or location

header Parameters
Optiturn-External-Bin-Changes-Version
required
string

Version of the External Bin Changes API

Value: "2023-05-01"
Responses
200

Bin-change information

400

The server cannot process the request due to a client error. Check the message and detail fields for further information.

401

Missing, expired, or invalid OAuth bearer token. Request a new token from the auth service.

500

An internal error occured. Please contact Optoro for further guidance.

503

Service is unavailable and/or over capacity. Please try again later.

504

Service is over capacity. Please try again later.

get/external_bin_changes/{id}
Response samples
application/json
{
  • "type": "unit",
  • "title": "Lightweight Down Puffer Jacket",
  • "image_url": "/images/no_image.png",
  • "id": "LPCN786457",
  • "sku": "LB23351-GMA01-650",
  • "upc": "OID645440561",
  • "directed_sorting": {
    }
}
© 2010 – 2024 Optoro, Inc. For official use only by authorized users. Use subject to terms of license agreement.