Query Item List

PostedJanuary 12, 2022

Get a list of your SKU by query parameters.

URL: {API root URL}/items?{query}
Method: GET

Request

URL Parameters

Parameter Name	Required	Data Type	Description
CustomerCode	Y	String	Your unique customer code assigned by Best system.
Content		String	The keyword you want to use in the item query, it will be matched in SKU number, Description and UPC.
Status		String	The current status of the SKU, below is available values:Creating. The SKU is being creating into Best Inc. system.Disabled. The SKU has been disabled.Enabled. The SKU is enabled, which is the normal status in Best Inc. system.Error. There is an error happended when create or update SKU information.Updating. The SKU is being updating into Best Inc. system.

Response

Attribute List

Element Name	Data Type	Description
Id	Integer	The internal ID of the SKU.
CustomerCode	String	Your unique customer code assigned by Best system
SKU	String	The unique number to identity your SKU
Description	String	The name of title of your SKU
Description2	String	Additional detail description of your SKU
UPC	String	The UPC code or barcode that will be printed on your product label, Best warehouse will scan this code to identify your product when receiving or picking your SKU.
UPC2	String	Additional UPC code (If any)
UPC3	String	Additional UPC code (If any)
Category	String	The value to indicate the category of your SKU. Please always contact your dedicated AM to predefine your Item Category in Best system before you apply it into your SKU.
InventoryClassification	String	The value to indicate the inventory classification for your item.
KitType	String	For Kit SKU, this will be the actual Kit Type “BOM” or “SetMaster”, for normal SKU, it will be “Component” always.
Length	Decimal	The length of your SKU
Width	Decimal	The width of your SKU
Height	Decimal	The height of your SKU
LengthUnit	String	The unit of the dimension fields (Length, Width, Height), value is always “Inch”.
Weight	Decimal	The weight of your SKU
WeightUnit	String	The unit of the weight, value is always “Pound”.
CommodityCode	String	Specified International tariff code.
CountryOfOrigin	String	Specified ISO Alpha-2 code of the originally produced country for your item.
BatteryFlag	Boolean	Indicate if this item includes any battery
HazmatFlag	Boolean	Indicate if this item is hazmat
LiquidFlag	Boolean	Indicate if this item includes liquid
FragileFlag	Boolean	Indicate if this item is fragile product
MfgDateRequired	Boolean	Indicate if this item is required to collect the manufacturing date when receiving this product into Best Inc. fulfillment centers.
ExpDateRequired	Boolean	Indicate if this item is required to collect the expiration date when receiving this product into Best Inc. fulfillment centers.
BatchNumberRequired	Boolean	Indicate if this item is required to collect the batch number when receiving this product into Best Inc. fulfillment centers.
CountryOfOriginRequired	Boolean	Indicate if this item is required to collect the country of origin when receiving this product into Best Inc. fulfillment centers.
SerialNumberRequired	Boolean	Indicate if this item is required to collect the serial number when receiving this product into Best Inc. fulfillment centers.
AltUnit	String	Indicate the unit type other than single piece for your SKU if it’s applicable, the available value is “Carton”.
AltQuantity	Integer	Indicate how many individual pieces are contained in each pack based on the unit type specified in AltUnit.
AltUPC	String	The UPC or barcode of your pack based on the unit type specified in AltUnit.
AltLength	Decimal	The length in unit Inch of your pack based on the unit type specified in AltUnit.
AltWidth	Decimal	The width in unit Inch of your pack based on the unit type specified in AltUnit.
AltHeight	Decimal	The height in unit Inch of your pack based on the unit type specified in AltUnit.
AltWeight	Decimal	The weight in unit Pound of your pack based on the unit type specified in AltUnit.
Status	String	The current status of the SKU, below is available values:Creating. The SKU is being creating into Best Inc. system.Disabled. The SKU has been disabled.Enabled. The SKU is enabled, which is the normal status in Best Inc. system.Error. There is an error happended when create or update SKU information.Updating. The SKU is being updating into Best Inc. system.
StatusDescription	String	The additional description of the status. When Status is Error, this field indicate the detail error message.
CreatedDate	DateTime	The date and time when the SKU is created
LastModifiedDate	DateTime	The date and time when the SKU is updated last time
LastestUpdateRequest	Object	The detail information of the previous update action
LastestUpdateRequest/Id	Integer	The internal ID of the previous update action
LastestUpdateRequest/ReviewStatus	Integer	The status of the previous update action, below is available values:None. The SKU doesn’t have previous update action.Pending. The previous update request was submitted successfully.Waiting for Review. The previous update request triggered Best Inc. internal review procedure and waiting for process.Reviewing. BEST team is working on the review process for your previous update action.Updated. The previous update request was completed, the updated value you submitted for all fields are verified and applied into Best Inc. system.Revised. The previous update request was completed, Best Inc. team revised the value of some fields after measurement on your physical SKU in our warehouse.Cancelling. The cancellation for the previous update request was submitted and being in process.Cancelled. The previous update request was cancelled.
LastestUpdateRequest/UpdateDate	Integer	The date & time when the previous item update request is done
LastestUpdateRequest/RequestDate	Integer	The date & time when the previous update action is submitted

Response Example

{
    "result": [
        {
            "id": 57052,
            "customerCode": "USSTAGE",
            "upc": "124445622565",
            "upc2": "124445622566",
            "upc3": "124445622567",
            "sku": "YQ-9999997",
            "description": "Anker Powerline II Cable (8ft)",
            "description2": "MFi Certified for iPhone 11 / XS/XS Max/XR/X / 8/8 Plus / 7/7 Plus / 6/6 Plus",
            "itemUnit": "Each",
            "kitType": "Component",
            "length": 5.45,
            "width": 3.00,
            "height": 2.00,
            "lengthUnit": "Inch",
            "weight": 1.12,
            "weightUnit": "Pound",
            "status": "Enabled",
            "statusDescription": "",
            "commodityCode": "",
            "countryOfOrigin": "CN",
            "altUnit": "Carton",
            "altUPC": "124445622565",
            "altQuantity": 4,
            "altLength": 11.65,
            "altWidth": 3.26,
            "altHeight": 4.12,
            "altWeight": 4.25,
            "latestUpdateRequest": {
                "id": 58,
                "reviewStatus": "Updated",
                "updateDate": "2020-06-03T16:40:01",
                "requestDate": "2020-06-03T16:29:45"
            }
        }
    ],
    "statusCode": 200
}