WOwove
Shipments

Create shipment

Create a new shipment in draft status.

post/api/v1/external/shipments

Request

Request body

namestring required
shipmentType'FCL' | 'LCL' | 'AIR' | 'LTL' | 'FTL' | 'RAIL'
commoditystring
carrierstring
vesselstring
voyagestring
incotermstring
serviceTypestring
portOfLoadingstring
portOfDischargestring
customFieldsobject

Example request

{
  "name": "My Shipment",
  "shipmentType": "FCL",
  "commodity": "Electronics",
  "carrier": "MSC",
  "vessel": "MSC OSCAR",
  "voyage": "123E",
  "incoterm": "FOB",
  "serviceType": "CY/CY",
  "portOfLoading": "CNSHA",
  "portOfDischarge": "USLAX",
  "placeOfReceipt": {
    "portCode": "USNYC",
    "portName": "New York/Newark",
    "countryCode": "US"
  },
  "placeOfDelivery": {
    "portCode": "USNYC",
    "portName": "New York/Newark",
    "countryCode": "US"
  },
  "referenceNumbers": [
    {
      "id": "1014810279825727493",
      "type": "booking",
      "displayNumber": "BOOK-2024-001",
      "cleanedNumber": "BOOK2024001"
    }
  ]
}

Response

Shipment created successfully

successboolean

Example response

{
  "data": {
    "creation": {
      "source": "email"
    },
    "emailUpdates": {
      "threads": 2
    },
    "sync": {
      "method": "manual",
      "status": "success",
      "syncedBy": {
        "name": "Jane Smith",
        "email": "jane@example.com"
      },
      "tmsReference": "C00012345"
    },
    "id": "1014810279825727490",
    "status": "draft",
    "name": "External API Test Shipment",
    "shipmentType": "LCL",
    "commodity": "Electronics",
    "portOfLoading": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "portOfDischarge": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfReceiptPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfReceiptAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfReceiptAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "placeOfDeliveryPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfDeliveryAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfDeliveryAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "documentCount": 5,
    "carrier": {
      "code": "MAEU",
      "name": "Maersk Line"
    },
    "vessel": "MSC OSCAR",
    "voyage": "123W",
    "incoterm": "FOB",
    "serviceType": "CY-CY",
    "referenceNumbers": [
      {
        "id": "1014810279825727493",
        "type": "booking",
        "displayNumber": "BOOK-2024-001",
        "cleanedNumber": "BOOK2024001"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.