Getting Shipment Data

This endpoint enables you to access information about your shipment. The response body is divided into three crucial parts: validation, export, and import.

Validation

The validation part provides feedback on the data you submitted by searching for potential errors. It can have three possible statuses:

• Success: Indicates that there are no errors, and the shipment has been successfully finalized.
• Pending: Indicates that the validation process is still ongoing, and you should await the results.
• Failure: Indicates that errors exist in your data, which need to be addressed before the shipment can be finalized.

Export and Import

The export and import sections will be included in the response only if your organization has previously enabled these services in the QuayConnect app. For each of these sections, you will receive:

• Status: Indicates whether the operation was successful.
• If successful, you will also receive:
• Document Type: Specifies the type of document generated.
• Document Number: Provides the document's unique identifier.
• Download Link: Offers a link for downloading the generated document.
• If the operation failed, you will receive an array of errors for further investigation and resolution.

To access shipment data via the endpoint, you must specify the unique ID of the shipment for which you want information. The shipment's ID will be provided to you in the response when creating a shipment.

Example API Request

GET https://api.quayconnect.io/v2/shipments/shipment-id
Headers:
Authorization: Bearer your-access-token

Example Successful Response

Upon successful handling of your request, you can expect to receive the following:

                    {
                        "validation": {
                          "status": "success",
                          "errors": [
                            {
                              "message": "string",
                              "slug": "string",
                              "fieldPath": "string"
                            }
                          ]
                        },
                        "export": {
                          "status": "success",
                          "documentType": "EU",
                          "documentNumber": "string",
                          "downloadLink": "string"
                        },
                        "import": {
                          "status": "success",
                          "documentType": "string",
                          "documentNumber": "string",
                          "downloadLink": "string",
                          "errors": [
                            {
                              "message": "string"
                            }
                          ]
                        }
                    }