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>",
"dateTimeStamp": "2023-11-07T05:31:56Z",
"senderParty": [
{
"primaryID": "<string>"
}
],
"recipientParty": [
{
"primaryID": "<string>"
}
],
"conversationID": "<string>"
},
"businessHeader": {
"bookingRequestID": "<string>",
"senderAssignedID": "<string>",
"includedHeaderNote": [
{
"contentCode": "<string>",
"content": "<string>"
}
]
},
"masterConsignment": {
"grossWeightMeasure": {
"value": 4999999.55
},
"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": "jsmith@example.com"
}
},
"role": "<string>",
"cargoAgentID": "<string>",
"specifiedCargoAgentLocation": {
"id": "<string>"
}
},
"specifiedLogisticsTransportMovement": [
{
"id": "<string>",
"spaceAllocationCode": "<string>",
"departureEvent": {
"scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrenceLocation": {
"id": "<string>",
"name": "<string>"
},
"latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
},
"arrivalEvent": {
"scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrenceLocation": {
"id": "<string>",
"name": "<string>"
},
"latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
},
"sequenceNumeric": 5000,
"mode": "<string>",
"pieceQuantity": 49999,
"tareGrossWeightMeasure": {
"value": 1
},
"grossVolumeMeasure": {
"value": 1
},
"allotmentID": "<string>",
"serviceCode": "<string>",
"productIdentifier": "<string>",
"usedLogisticsTransportMeans": {
"name": "<string>"
},
"serviceParameters": {
"totalTransitTime": 123,
"latestAcceptanceTime": "<string>",
"timeOfAvailability": "<string>"
}
}
],
"id": "<string>",
"grossVolumeMeasure": {
"value": 1
},
"densityGroupCode": "<string>",
"productID": "<string>",
"summaryDescription": "<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
},
"originCountry": {
"id": "<string>"
},
"packageDetails": [
{
"typeCode": "<string>",
"quantity": 2,
"grossWeightMeasure": {
"value": 1
},
"lengthMeasure": {
"value": 1
},
"widthMeasure": {
"value": 1
},
"heightMeasure": {
"value": 1
}
}
]
}
]
}
}
'{
"id": "<string>",
"bookingRequestID": "<string>",
"awbNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"xffrMessageID": "<string>"
}Bookings
Create XFFR-Compliant Booking
Creates a new shipment booking using IATA XFFR v3.10 standard format. Supports both XML and JSON representations of the XFFR message.
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>",
"dateTimeStamp": "2023-11-07T05:31:56Z",
"senderParty": [
{
"primaryID": "<string>"
}
],
"recipientParty": [
{
"primaryID": "<string>"
}
],
"conversationID": "<string>"
},
"businessHeader": {
"bookingRequestID": "<string>",
"senderAssignedID": "<string>",
"includedHeaderNote": [
{
"contentCode": "<string>",
"content": "<string>"
}
]
},
"masterConsignment": {
"grossWeightMeasure": {
"value": 4999999.55
},
"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": "jsmith@example.com"
}
},
"role": "<string>",
"cargoAgentID": "<string>",
"specifiedCargoAgentLocation": {
"id": "<string>"
}
},
"specifiedLogisticsTransportMovement": [
{
"id": "<string>",
"spaceAllocationCode": "<string>",
"departureEvent": {
"scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrenceLocation": {
"id": "<string>",
"name": "<string>"
},
"latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
},
"arrivalEvent": {
"scheduledOccurrenceDateTime": "2023-11-07T05:31:56Z",
"occurrenceLocation": {
"id": "<string>",
"name": "<string>"
},
"latestAcceptanceRelatedDateTime": "2023-11-07T05:31:56Z"
},
"sequenceNumeric": 5000,
"mode": "<string>",
"pieceQuantity": 49999,
"tareGrossWeightMeasure": {
"value": 1
},
"grossVolumeMeasure": {
"value": 1
},
"allotmentID": "<string>",
"serviceCode": "<string>",
"productIdentifier": "<string>",
"usedLogisticsTransportMeans": {
"name": "<string>"
},
"serviceParameters": {
"totalTransitTime": 123,
"latestAcceptanceTime": "<string>",
"timeOfAvailability": "<string>"
}
}
],
"id": "<string>",
"grossVolumeMeasure": {
"value": 1
},
"densityGroupCode": "<string>",
"productID": "<string>",
"summaryDescription": "<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
},
"originCountry": {
"id": "<string>"
},
"packageDetails": [
{
"typeCode": "<string>",
"quantity": 2,
"grossWeightMeasure": {
"value": 1
},
"lengthMeasure": {
"value": 1
},
"widthMeasure": {
"value": 1
},
"heightMeasure": {
"value": 1
}
}
]
}
]
}
}
'{
"id": "<string>",
"bookingRequestID": "<string>",
"awbNumber": "<string>",
"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
ApiKeyAuthApiKeyHeader
Body
application/jsonapplication/xml
⌘I