Uploading Order Related Document
Upload your order related documents into Best Inc. system after you creating the order, you are also able to attachment the document(s) when you create order, refer to Order Creation interface for detail information.
Refer to Order Documents page for more detail information.
- URL: {API root URL}/orders/documents
- Method: POST
Request
Attribute List
Element Name | Required | Data Type | Description |
---|---|---|---|
CustomerCode | Y | String | Your unique customer code assigned by Best system. |
OrderNumber | Y | String | An unique number to identify your order. |
DocumentTypes | Y | Array | The type of the order document, below values are expected: • SHIPPING_LABEL • BILL_OF_LADING • PRODUCT_LABEL • CARTON_LABEL • PALLET_LABEL • PACKING_LIST • COMMERCIAL_INVOICE • OTHERS Please note. You can specify multiple types for one file. Apply to the case when the file from Amazon FBA will include both carton label and shipping label. |
FileName | Y | String | The file name of the document, extension name should be included such as “.pdf”, “.png”. File name can’t be duplicated in all documents in same order. |
MimeType | Y | String | The standard HTTP MIME type to describe the type of the document file, the value has to match with the extension name specified in FileName field. Below is the acceptable MIME types and file types in Best Inc. system: • image/png: PNG image, file extension name should be “.png”. • image/jpeg: JPEG image, file extension name should be “.jpg” or “.jpeg”. • image/gif: GIF image, file extension name should be “.gif”. • application/pdf: PDF file, file extension name should be “.pdf”. • application/vnd.openxmlformats-officedocument.wordprocessingml.document: Microsoft Word file (OpenXML), file extension name should be “.docx”. |
Description | String | Any comment text for current document. | |
data or url | Y | String | The file content data encoded by Base64. This is to specify whether the encoded bytecode or the Label URL to be uploaded. Available values: • data– Indicates request is for encoded Base64. • url- Indicates the file download URL location. |
Request Example
{ "customerCode": "TEST", "orderNumber": "L34633027", "documentTypes": ["SHIPPING_LABEL"], "fileName": "sp.pdf", "mimeType": "application/pdf", "description": "Shipping Label", "data": "{actual base64 content for your file}" }
Response
Attribute List
Element Name | Data Type | Description |
---|---|---|
DocumentKey | String | The internal key of the uploaded document. |
Response Example
{ "documentKey": "ST01130413_sp.pdf" }