v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Carrier Integration Service Contract

Get shipment

The request a Xentral instance makes to an external carrier service to get a shipment.

get/xentral/shipments/{id}

Path parameters

idstring required

The ID of the shipment.

Response

Response body for generating a shipment.

idstring required

The Unique ID of the shipment. This ID is used to cancel the shipment and must be unique across all shipments generated by the service.

Example response

{
  "shippingLabels": [
    {
      "parcelId": "675ea55c-ab95-425a-977f-c70da64aa3e2",
      "trackingId": "123456789",
      "trackingUrl": "https://tracking.post.ch/track/123456789",
      "label": {
        "type": "pdf",
        "data": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAADOSURBVHgB1ZZpDoUwCITxnaT3v1SP0mdN49YNEDJKbPxhmfnSBVwS0frg4kfguAKEQBTjuibJZ2Tt7HGO/XMIxzvGZB5Z8+xRfA+A+wRLiJZ2BdCb6GGeowkwSrA0HwLMEi3MpwAcgSfmLACukDaHBSARlM5lA3CFpaslApgZaLZKDNAz0h5WFUALQntT1AB3CG2tKLnwdvyxLYAeQug1hBYiaCmGNiNoO35iztV45y+ZpfkMogLwMB9BVABe5j2ICsDTvAVRxrJRAAPejv8TASt8b/v+egAAAABJRU5ErkJggg=="
      }
    }
  ],
  "id": "675ea55c-ab95-425a-977f-c70da64aa3e2",
  "carrier": {
    "name": "Post Swiss"
  }
}