Create a shipment

Typically, when warehouse need to be notified that goods will arrive, a shipment is created with some preliminary info. Similar, when the goods are in storage and are ready to be delivered, a shipment with preparation(s) can be created.

• customerReference can be used to map any key from the agent/forwarder system.

• orderReference can be set with E-ONERECORD for export, I-ONERECORD for import, P-ONERECORD for export delivery order. Once handled by the warehouse it will be reset to identify that shipment for that particular operator (with the year on 2 digit and an incrementing number, e.g. E24001234).

• departure and departureCountry represent the starting place (e.g. CDG) and country (e.g. FR).

• arrival and arrivalCountry represent the destination place (e.g. NRT) and country (e.g. JP).

• quantityExpected and quantityTypeExpected give the amount of items in the shipment (integer value) and optionally the type (e.g. PAL).

• grossWeightExpected and grossWeightTaxableExpected are used for the awaited weight of the shipment in kilogram (KG).

• volumeExpected to inform the volume of the shipment in cubic meter (m³).

• mawbNumber inform about the Master Air Way Bill and hawbNumber the House Air Way Bill.

• goodsDescrition is needed to inform about the nature of the goods.

• fly could be used to inform about the flight used for the goods transportation.

• isSecure

  • can be used for an export shipment to indicate that the goods will arrive already secured (e.g. security screening done at factory).

  • can be used for a delivery preparation to validate that every houses under the master are all secured.

• isDangerous will be used for dangerous goods. The details will typically contains the corresponding dangerous class and/or UN classification.

• limitBoardingTime is used when creating a delivery order to inform warehouse when the shipment need to be delivered to the air company at latest.

It is not possible to record the same HAWB and MAWB during an import shipment insertion.

Create shipment

post

Create shipment

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

orderReferencestring | nullableRequired

customerReferencestring | nullableRequired

quantityExpectednumber | nullableRequired

quantityTypeExpectedstring · enum | nullableRequiredPossible values:

grossWeightExpectednumber | nullableRequired

grossWeightTaxableExpectednumber | nullableRequired

volumeExpectednumber | nullableRequired

quantityRealnumber | nullableRequired

quantityTypeRealstring · enum | nullableRequiredPossible values:

grossWeightRealnumber | nullableRequired

grossWeightTaxableRealnumber | nullableRequired

volumeRealnumber | nullableRequired

mawbNumberstring | nullableRequired

hawbNumberstring | nullableRequired

hblstring | nullableRequired

mblstring | nullableRequired

goodsDescriptionstring | nullableRequired

flystring | nullableRequired

shipstring | nullableRequired

isSecurebooleanOptionalDefault: false

isDangerousbooleanOptionalDefault: false

limitBoardingTimestring | nullableRequired

shippingReferencestring | nullableRequired

departurestring | nullableRequired

departureCountrystring · enum | nullableRequiredPossible values:

arrivalstring | nullableRequired

arrivalCountrystring · enum | nullableRequiredPossible values:

Responses

201Success

application/json

400

Bad Request

application/json

401

Unauthorized Entity

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

post

/shipment

HTTPcURLJavaScriptPython

POST /shipment HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1802

{
  "orderReference": "text",
  "customerReference": "text",
  "quantityExpected": 1,
  "quantityTypeExpected": "AUT",
  "grossWeightExpected": 1,
  "grossWeightTaxableExpected": 1,
  "volumeExpected": 1,
  "quantityReal": 1,
  "quantityTypeReal": "AUT",
  "grossWeightReal": 1,
  "grossWeightTaxableReal": 1,
  "volumeReal": 1,
  "mawbNumber": "text",
  "hawbNumber": "text",
  "hbl": "text",
  "mbl": "text",
  "goodsDescription": "text",
  "fly": "text",
  "ship": "text",
  "isSecure": false,
  "isDangerous": false,
  "limitBoardingTime": "text",
  "shippingReference": "text",
  "departure": "text",
  "departureCountry": "AD",
  "arrival": "text",
  "arrivalCountry": "AD",
  "assignations": [
    {
      "user": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "anomalies": [
    {
      "type": "text",
      "category": "text",
      "quantity": 1,
      "balance": 1,
      "date": null,
      "observation": "text"
    }
  ],
  "customs": [
    {
      "type": "text",
      "status": "text",
      "number": "text",
      "date": null
    }
  ],
  "details": [
    {
      "goodsDescription": "text",
      "quantity": 1,
      "quantityType": "text",
      "weight": 1,
      "width": 1,
      "height": 1,
      "length": 1,
      "support": "text",
      "location": "text",
      "volume": 1,
      "dangerousClass": "text",
      "unClassification": "text",
      "additionalReference": "text",
      "serialNumber": "text",
      "ecv": "text",
      "icv": "text"
    }
  ],
  "events": [
    {
      "eta": null,
      "ata": null,
      "comment": "text",
      "type": "ARRIVAL"
    }
  ],
  "operators": [
    {
      "code": "CONSIGNEE",
      "address": "text",
      "addressComplementary": "text",
      "postalCode": "text",
      "city": "text",
      "name": "text",
      "contact": "text",
      "email": "[email protected]",
      "tel": "text",
      "fax": "text",
      "phone": "text",
      "agreementNumber": "text",
      "agreementValidity": null,
      "society": "text",
      "country": "AD",
      "comments": [
        {
          "comment": "text",
          "societies": [
            {
              "society": "text"
            }
          ]
        }
      ]
    }
  ],
  "securities": [
    {
      "agent": "text",
      "quantity": 1,
      "status": "text",
      "position": "text",
      "securedAt": null,
      "type": "text"
    }
  ],
  "services": [
    {
      "quantity": 1,
      "isDone": true,
      "type": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "preparations": [
    {
      "shipment": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "departure": "text",
  "departureCountry": "AD",
  "arrival": "text",
  "arrivalCountry": "AD",
  "orderReference": "text",
  "customerReference": "text",
  "quantityExpected": 1,
  "quantityTypeExpected": "AUT",
  "grossWeightExpected": 1,
  "grossWeightTaxableExpected": 1,
  "volumeExpected": 1,
  "quantityReal": 1,
  "quantityTypeReal": "AUT",
  "grossWeightReal": 1,
  "grossWeightTaxableReal": 1,
  "volumeReal": 1,
  "mawbNumber": "text",
  "hawbNumber": "text",
  "hbl": "text",
  "mbl": "text",
  "goodsDescription": "text",
  "fly": "text",
  "ship": "text",
  "isSecure": false,
  "isDangerous": false,
  "limitBoardingTime": "text",
  "shippingReference": "text",
  "assignations": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "anomalies": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "customs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "details": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "documents": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "events": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "operators": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "securities": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "services": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "preparations": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": null,
  "updatedAt": null
}