INintersoftsapient
Shipments

Create Shipment Async

Create a shipment request for asynchronous processing. Unlike the standard Create Shipment endpoint, this endpoint performs only initial validation on the shipment data and does not return a label in the response. <br /> <br />If the request passes validation and a Shipments Webhook is configured, the shipment is queued for background processing. The response from the Create Shipment request will be pushed to the webhook. <br /> <br />The immediate API response contains only a RequestId, which can be used to track and correlate the request with subsequent webhook responses. <br /> <br />Note: This endpoint must only be used when the Shipments Webhook is configured within the SAPIENT UI.

post/v4/shipments/async/DX

Request

  • Base URL
    https://api.intersoftsapient.net
  • URL
    https://api.intersoftsapient.net/v4/shipments/async/DX
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.intersoftsapient.net/connect/token

Request body

Example request

{
  "ShipmentInformation": {
    "ServiceCode": "CRL1",
    "DescriptionOfGoods": "Clothing",
    "DeclaredValue": 98.99,
    "DeclaredWeight": 1.5,
    "CurrencyCode": "GBP",
    "ContainerId": "South East"
  },
  "Shipper": {
    "ShippingAccountId": "453",
    "ShippingLocationId": "938",
    "Reference1": "REF-12345-GB",
    "Reference2": "EXTERNALREF-12345-GB",
    "DepartmentNumber": "0123456789",
    "EoriNumber": "GB 123 4567 89 000",
    "VatNumber": "GB 123 4567 89",
    "Address": {
      "AddressId": "John Brown Default",
      "ContactName": "Jane Doe",
      "CompanyName": "My Company Ltd.",
      "ContactEmail": "jane@example.com",
      "ContactPhone": "07123887422",
      "Line1": "Brown Cottage",
      "Line2": "10 Sky Lane",
      "Line3": "Hills End",
      "Town": "Christchurch",
      "Postcode": "TW20 0HJ",
      "County": "Surrey",
      "CountryCode": "GB",
      "What3Words": "brick.space.employ"
    }
  },
  "Destination": {
    "EoriNumber": "GB 123 4567 89 000",
    "VatNumber": "GB 123 4567 89",
    "Address": {
      "AddressId": "John Brown Default",
      "ContactName": "Jane Doe",
      "CompanyName": "My Company Ltd.",
      "ContactEmail": "jane@example.com",
      "ContactPhone": "07123887422",
      "Line1": "Brown Cottage",
      "Line2": "10 Sky Lane",
      "Line3": "Hills End",
      "Town": "Christchurch",
      "Postcode": "TW20 0HJ",
      "County": "Surrey",
      "CountryCode": "GB",
      "What3Words": "brick.space.employ"
    }
  },
  "Packages": [
    {
      "PackageOccurrence": 1,
      "DeclaredWeight": 1.5,
      "DeclaredValue": 98.99,
      "Dimensions": {
        "Length": 35,
        "Width": 25,
        "Height": 20
      }
    }
  ],
  "Items": [
    {
      "SkuCode": "C604-25-035",
      "PackageOccurrence": 1,
      "Quantity": 1,
      "Description": "White Tee-shirt",
      "Value": 98.99,
      "Weight": 145,
      "ImageURL": "https://yourcompany.com/images/product.jpg",
      "HSCode": "6109100010",
      "CountryOfOrigin": "GB",
      "SupplementaryUnits": 12.2
    }
  ],
  "Customs": {
    "ReasonForExport": "Sale of Goods",
    "PreRegistrationNumber": "0123456789",
    "PreRegistrationType": "GST",
    "ShippingCharges": 55.82,
    "OtherCharges": 32,
    "QuotedLandedCost": 82.74,
    "Airn": "231.002.999-00"
  },
  "ReturnToSender": {
    "Address": {
      "AddressId": "John Brown Default",
      "ContactName": "Jane Doe",
      "CompanyName": "My Company Ltd.",
      "ContactEmail": "jane@example.com",
      "ContactPhone": "07123887422",
      "Line1": "Brown Cottage",
      "Line2": "10 Sky Lane",
      "Line3": "Hills End",
      "Town": "Christchurch",
      "Postcode": "TW20 0HJ",
      "County": "Surrey",
      "CountryCode": "GB",
      "What3Words": "brick.space.employ"
    }
  }
}

Response

The shipment was created successfully.

RequestIdstring uuid

A unique identifier generated by SAPIENT for each shipment request submitted via the Create Shipment Async endpoint. This ID used to match the subsequent asynchronous Shipment Webhook response with the original request.

Changes

No recorded changes to this operation across all 1 revision of this API.