0ne Record Docs
  • GENERAL OVERVIEW
    • Introduction
    • Before getting started
    • Changelog
    • Status
  • About the API
    • Environments
    • Versionning
      • Breaking change
    • Conditions & Limit
    • Pagination
    • Date Handling
    • Identifier
    • Filtering and Sorting
    • Groups
    • Troubleshooting
  • Security
    • Authentication
    • Authorization
  • REST API
    • Container
      • Get all container
      • Get a container by id
      • Create a container
      • Update a container
      • Delete a container
    • Container Type
      • Get all container type
      • Get a container type by type
      • Create a container type
      • Update a container type
      • Delete a container type
    • Country
    • Place
    • Shipment
      • Get all shipment
      • Get shipment by id
      • Create a shipment
      • Update a shipment
      • Delete a shipment
    • Shipment Anomaly
      • Get all shipment anomaly
      • Get a shipment anomaly by id
      • Create a shipment anomaly
      • Update a shipment anomaly
      • Delete a shipment anomaly
    • Shipment Anomaly Category
      • Get all shipment anomaly category
      • Get a shipment anomaly category by name
      • Create a shipment anomaly category
      • Delete a shipment anomaly category
    • Shipment Anomaly Type
      • Get all shipment anomaly type
      • Get a shipment anomaly type by code
      • Create a shipment anomaly type
      • Update a shipment anomaly type
      • Delete a shipment anomaly type
    • Shipment Customs
      • Get all shipment customs
      • Get shipment customs by id
      • Create a shipment customs
      • Update a shipment customs
      • Delete a shipment customs
    • Shipment Customs Type
      • Get all shipment customs type
      • Get shipment customs type by name
    • Shipment Detail
      • Get all shipment detail
      • Get shipment detail by id
    • Shipment Document
      • Get all shipment document
      • Get shipment document by id
      • Create a shipment document
      • Delete a shipment document
    • Shipment Event
      • Get all shipment events
      • Get shipment event by id
      • Create a shipment event
      • Update a shipment event
      • Delete a shipment event
    • Shipment Event Type
      • Get all shipment event type
      • Get shipment event type by name
    • Shipment Operator
      • Get all shipment operator
      • Get shipment operator by id
      • Create a shipment operator
      • Update a shipment operator
      • Delete a shipment operator
    • Shipment Preparation
      • Get all shipment preparation
      • Get shipment preparation by id
      • Create a shipment preparation
      • Update a shipment preparation
      • Delete a shipment preparation
    • Shipment Security
      • Get all shipment security
      • Get shipment security
      • Create a shipment security
      • Update a shipment security
      • Delete a shipment security
    • Shipment Security Type
      • Get all shipment security type
      • Get shipment security type by code
    • Shipment Service
      • Get all shipment service
      • Get shipment service by id
      • Create a shipment service
      • Update a shipment service
      • Delete a shipment service
    • Shipment Service Type
      • Get all shipment service type
      • Get shipment service type by id
      • Create a shipment service type
      • Update shipment service type
      • Delete a shipment service type
    • Society Subscription
      • Get all society subscription
      • Get a society subscription by id
      • Create a society subscription
      • Update a society subscription
      • Delete a society subscription
  • Notification
    • Webhook
      • Request
      • Restriction & Limitation
      • Supported Authentication Methods
      • Payload signature
    • SocketIO
      • Environments
      • Authentication
      • Authorization
      • Namespaces
        • Shipment Notification Namespace
      • Handling Errors
    • Example payload
      • Shipment payload
      • Shipment event payload
      • Shipment operator
Powered by GitBook
On this page
  • Shipment
  • Related objects
  1. REST API

Shipment

A shipment refers to a collection of goods or items being transported from one location to another. It typically involves packaging, labeling, and documentation for transportation by air, sea, rail,…

PreviousPlaceNextGet all shipment

Last updated 8 months ago

Shipment

Shipment contains information such as expected quantity and type, weight, volume, goods description, order reference from warehouse, customer reference from forwarder, etc. Depending on the type of shipment, it might also contains e.g. MAWB number for import or export delivery preparation, HAWB number for import or export shipment, limit boarding time for export delivery preparation,…

Shipments are accessible only for theirs operators (warehouse, forwarder, shipper, etc.) during their lifespan.

Related objects

Many shipment information are stored in related objects.

  • represent societies operating on the shipment with their role such as FORWARDER, WAREHOUSE, SHIPPER or CONSIGNEE.

  • follow the time line of the shipment, from ORDER to DELIVERY.

  • give extra information for every pieces of the shipment, typically after MEASUREMENT event, such as length, width, height, weight, dangerous class and UN classification for dangerous goods.

  • is used when forwarder will ask extra operations on the shipment like WOOD PALLET, FILM WRAPPING, etc.

  • tell what type of securities method were applied to the shipment, typically after SECURITY event, such as X-Ray, Explosive Detection Dog,…

  • provide information about files attached to the shipment such as URL to download the security manifest pdf.

  • Preparations allow to group multiple shipments together like for an export delivery order where the shipment will store the MAWB number, limit boarding time and destination and linked shipments representing the HAWB in the grouping.

  • Deliveries make possible to track the different order numbers attached to the shipment through its life cycle, from import/export number, to delivery preparation number in grouping/ungrouping , to delivery number.

  • store customs numbers related to the shipment.

  • give information about anything that went wrong with the shipment such as problems at import reception, rejected MAWB at export, etc. with the details like deficit, broken package,…

Operators
Events
Details
Services
Securities
Documents
Customs
Anomalies