Skip to main content
POST
/
api
/
bookings
/
xffr
Create XFFR-Compliant Booking
curl --request POST \
  --url https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io/api/bookings/xffr \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageHeader": {
    "messageReferenceID": "<string>",
    "messageName": "Air Waybill",
    "messageType": "740",
    "dateTimeStamp": "2023-11-07T05:31:56Z",
    "messageFunction": "Creation",
    "messageVersion": "3.10",
    "senderParty": [
      {
        "primaryID": "<string>",
        "schemeID": "C"
      }
    ],
    "recipientParty": [
      {
        "primaryID": "<string>",
        "schemeID": "C"
      }
    ],
    "conversationID": "<string>"
  },
  "businessHeader": {
    "bookingRequestID": "<string>",
    "senderAssignedID": "<string>",
    "includedHeaderNote": [
      {
        "contentCode": "<string>",
        "content": "<string>"
      }
    ]
  },
  "masterConsignment": {
    "grossWeightMeasure": {
      "value": 4999999.55,
      "unitCode": "KGM"
    },
    "loadTypeCode": "BLK",
    "shipmentTypeCode": "T",
    "totalPieceQuantity": 49999,
    "requestorParty": {
      "name": "<string>",
      "roleCode": "<string>",
      "primaryID": "<string>",
      "accountID": "<string>",
      "postalStructuredAddress": {
        "postcodeCode": "<string>",
        "streetName": "<string>",
        "cityName": "<string>",
        "cityID": "<string>",
        "countryID": "<string>",
        "countryName": "<string>",
        "countrySubDivisionName": "<string>",
        "countrySubDivisionID": "<string>"
      },
      "definedTradeContact": {
        "personName": "<string>",
        "departmentName": "<string>",
        "directTelephoneCommunication": {
          "completeNumber": "<string>"
        },
        "uriEmailCommunication": {
          "uriID": "[email protected]"
        }
      },
      "role": "<string>",
      "cargoAgentID": "<string>",
      "specifiedCargoAgentLocation": {
        "id": "<string>"
      }
    },
    "specifiedLogisticsTransportMovement": [
      {
        "stageCode": "Pre-Carriage",
        "id": "<string>",
        "spaceAllocationCode": "<string>",
        "departureEvent": {
          "scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
          "occurrenceLocation": {
            "id": "<string>",
            "name": "<string>",
            "typeCode": "Airport"
          },
          "latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
        },
        "arrivalEvent": {
          "scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
          "occurrenceLocation": {
            "id": "<string>",
            "name": "<string>",
            "typeCode": "Airport"
          },
          "latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
        },
        "sequenceNumeric": 5000,
        "modeCode": "4",
        "mode": "<string>",
        "pieceQuantity": 49999,
        "tareGrossWeightMeasure": {
          "value": 1,
          "unitCode": "KGM"
        },
        "grossVolumeMeasure": {
          "value": 1,
          "unitCode": "MTQ"
        },
        "allotmentID": "<string>",
        "serviceCode": "<string>",
        "productIdentifier": "<string>",
        "usedLogisticsTransportMeans": {
          "name": "<string>"
        },
        "serviceParameters": {
          "serviceParameterTypeCode": "T",
          "totalTransitTime": 123,
          "latestAcceptanceTime": "<string>",
          "timeOfAvailability": "<string>",
          "serviceParameterResponseCode": "SPKK"
        }
      }
    ],
    "id": "<string>",
    "grossVolumeMeasure": {
      "value": 1,
      "unitCode": "MTQ"
    },
    "densityGroupCode": "<string>",
    "productID": "<string>",
    "summaryDescription": "<string>",
    "consignorParty": {
      "name": "<string>",
      "primaryID": "<string>",
      "accountID": "<string>",
      "postalStructuredAddress": {
        "postcodeCode": "<string>",
        "streetName": "<string>",
        "cityName": "<string>",
        "cityID": "<string>",
        "countryID": "<string>",
        "countryName": "<string>",
        "countrySubDivisionName": "<string>",
        "countrySubDivisionID": "<string>"
      },
      "definedTradeContact": {
        "personName": "<string>",
        "departmentName": "<string>",
        "directTelephoneCommunication": {
          "completeNumber": "<string>"
        },
        "uriEmailCommunication": {
          "uriID": "[email protected]"
        }
      }
    },
    "consigneeParty": {
      "name": "<string>",
      "primaryID": "<string>",
      "accountID": "<string>",
      "postalStructuredAddress": {
        "postcodeCode": "<string>",
        "streetName": "<string>",
        "cityName": "<string>",
        "cityID": "<string>",
        "countryID": "<string>",
        "countryName": "<string>",
        "countrySubDivisionName": "<string>",
        "countrySubDivisionID": "<string>"
      },
      "definedTradeContact": {
        "personName": "<string>",
        "departmentName": "<string>",
        "directTelephoneCommunication": {
          "completeNumber": "<string>"
        },
        "uriEmailCommunication": {
          "uriID": "[email protected]"
        }
      }
    },
    "originLocation": {
      "id": "<string>",
      "name": "<string>"
    },
    "finalDestinationLocation": {
      "id": "<string>",
      "name": "<string>"
    },
    "handlingSPHInstructions": [
      {
        "descriptionCode": "<string>",
        "description": "<string>"
      }
    ],
    "handlingSSRInstructions": [
      {
        "description": "<string>",
        "descriptionCode": "<string>"
      }
    ],
    "includedCustomsNote": [
      {
        "content": "<string>",
        "contentCode": "<string>",
        "subjectCode": "<string>",
        "countryID": "<string>"
      }
    ],
    "includedMasterConsignmentItem": [
      {
        "typeCode": "<string>",
        "pieceQuantity": 49999,
        "grossWeightMeasure": {
          "value": 1,
          "unitCode": "KGM"
        },
        "originCountry": {
          "id": "<string>"
        },
        "packageDetails": [
          {
            "typeCode": "<string>",
            "quantity": 2,
            "grossWeightMeasure": {
              "value": 1,
              "unitCode": "KGM"
            },
            "lengthMeasure": {
              "value": 1,
              "unitCode": "CMT"
            },
            "widthMeasure": {
              "value": 1,
              "unitCode": "CMT"
            },
            "heightMeasure": {
              "value": 1,
              "unitCode": "CMT"
            }
          }
        ]
      }
    ]
  }
}
'
{
  "id": "<string>",
  "bookingRequestID": "<string>",
  "awbNumber": "<string>",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "xffrMessageID": "<string>"
}

Reference Documentation

For more information on XFFR-compliant bookings using IATA standards, please refer to:
  • IATA XFFR v3.10
  • IATA Reference: XFFR / EQ.E6ACA.10
  • Message Type: 740 (Air Waybill)
  • Version: 3.10

Authorizations

Authorization
string
header
required

Body

messageHeader
object
required
businessHeader
object
required
masterConsignment
object
required

Response

Booking created successfully

id
string
bookingRequestID
string
awbNumber
string
status
enum<string>
Available options:
pending,
confirmed,
rejected,
alternative
createdAt
string<date-time>
xffrMessageID
string