List purposes of shipment

GET/client_api/v2/purpose_of_shipments

The incoterms your company may quote with. A quote's and an order's purpose_of_shipment_id comes from here.

Parameters

No parameters.

Returns

Returns a list of purpose of shipments.

Errors

• 401Unauthorized
  The token is missing, expired or invalid. Sign in again.

View as Markdown

GET /client_api/v2/purpose_of_shipments

cURLJavaScriptPythonPHPC#Ruby

1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/purpose_of_shipments" \
2  -H "Authorization: Bearer $API_TOKEN"

Response200 OK401 Unauthorized

{
  "purpose_of_shipments": [
    {
      "id": 22,
      "code": "SALE",
      "description": "Sale of goods",
      "explanation": null
    }
  ],
  "meta": {
    "page_count": 1,
    "record_count": 1
  }
}