Creating a Shipment

With your contacts and products in place, you are now ready to initiate shipments using our API. You can create shipments in two distinct ways: using our native format or a non-native format, as agreed upon with administrators.

Types of Requests:

• Product Code-Based Request: For each product, you can enter product code and ommit the following fields: commodity code, country of origin and description.


caution

You can use this method of shipment creation only if you have previously created a product and it has been verified by the administartors.

• Detailed Description Request: If you prefer to provide details for each item or you have not created a product in the UI, you can include the entire product data.

Creating a Shipment with Native Format

To create a shipment using the native format, you will require your API key and a JSON object that comprehensively describes your shipment. You can find the detailed specification for this JSON object in the endpoint description. An example request in this format is shown below:

POST https://api.quayconnect.io/v2/shipments
Headers:
Authorization: Bearer your-access-token
Content-Type: application/json

Request Body:
 See the details here 

Creating a Shipment with Non-Native Format:

For those cases where a non-native format is necessary, you will still need your API key, but you will also require a file with an extension agreed upon with our administrators. An example request using an XML file is provided as follows:

POST https://api.quayconnect.io/v2/shipments/external
Headers:
Authorization: Bearer your-access-token
Content-Type: application/xml

Request Body:
 See the details here 

Example Successful Response

If everything went smoothly, you will get the following response

                    {
                        "shipmentId": "string"
                    }
                    

From now on, whenever you want to access your shipment data, alter it or attach the documents, you need to provide this shipment id.