Update a shipment

Depending on the state of a shipment, some or all of its attributes can be modified. List of attributes are described in create shipment page.

As long as it is not handled by the warehouse, all the attributes can be modified:

• after creation of export shipment with ORDER event, before GOODS_RECEIPT event.

• after creation of import shipment with ORDER event, before PICKUP or GOODS_RECEIPT event, whichever comes first.

• after creation of export delivery shipment with DELIVERY_ORDER event, before DELIVERY_PREPARATION event.

For export shipment, as long as it has not reach the DELIVERY_PREPARATION event, the master mawbNumber and house hawbNumber numbers can be added/modified. This is also the last moment at which e.g. services can be added.

For every type of shipments, the customerReference can be modified until the final DELIVERY_COMPANY/DELIVERY event. Once delivered, the shipment will be archived in read-only mode, so not editable any more.

Update shipment

put

Update shipment

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

shipmentIdstringRequired

Body

application/json

orderReferencestring · max: 90 · nullableOptional

customerReferencestring · max: 90 · nullableOptional

quantityExpectednumber · nullableOptional

quantityTypeExpectedstring · enum · nullableOptionalPossible values:

grossWeightExpectednumber · nullableOptional

grossWeightTaxableExpectednumber · nullableOptional

volumeExpectednumber · nullableOptional

quantityRealnumber · nullableOptional

quantityTypeRealstring · enum · nullableOptionalPossible values:

grossWeightRealnumber · nullableOptional

grossWeightTaxableRealnumber · nullableOptional

volumeRealnumber · nullableOptional

mawbNumberstring · min: 1 · max: 255 · nullableOptional

hawbNumberstring · max: 255 · nullableOptional

hblstring · max: 255 · nullableOptional

mblstring · max: 255 · nullableOptional

goodsDescriptionstring · max: 255 · nullableOptional

flystring · max: 255 · nullableOptional

shipstring · max: 255 · nullableOptional

isSecurebooleanOptionalDefault: false

isDangerousbooleanOptionalDefault: false

limitBoardingTimestring · max: 255 · nullableOptional

shippingReferencestring · max: 255 · nullableOptional

departurestring · nullableOptional

departureCountrystring · enum · nullableOptionalPossible values:

arrivalstring · nullableOptional

arrivalCountrystring · enum · nullableOptionalPossible values:

Responses

200Success

application/json

shipmentIdstring · uuidRequired

departureone of · nullableRequired

stringOptional

or

departureCountryone of · nullableRequired

string · enumOptionalPossible values:

or

arrivalone of · nullableRequired

stringOptional

or

arrivalCountryone of · nullableRequired

string · enumOptionalPossible values:

or

orderReferencestring · max: 90 · nullableRequired

customerReferencestring · max: 90 · 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 · min: 1 · max: 255 · nullableRequired

hawbNumberstring · max: 255 · nullableRequired

hblstring · max: 255 · nullableRequired

mblstring · max: 255 · nullableRequired

goodsDescriptionstring · max: 255 · nullableRequired

flystring · max: 255 · nullableRequired

shipstring · max: 255 · nullableRequired

isSecurebooleanOptionalDefault: false

isDangerousbooleanOptionalDefault: false

limitBoardingTimestring · max: 255 · nullableRequired

shippingReferencestring · max: 255 · nullableRequired

createdAtanyRequired

updatedAtany · nullableRequired

400

Bad Request

application/json

401

Unprocessable Entity

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

put

/shipment/{shipmentId}

HTTPcURLJavaScriptPython

PUT /shipment/{shipmentId} HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 572

{
  "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"
}

{
  "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
}