Create a shipment service

📄 Technical specifications

Consignee

The Consignee is not allowed to create this resource.

Forwarder

The Forwarder is not allowed to create this resource.

Shipper

The Shipper is allowed to create this resource when the event type name is ORDER, PICKUP, GOODS_RECEIPT, MEASUREMENT, SECURITY, or STORAGE.

Warehouse

The Warehouse is allowed to create this resource when the event type name is ORDER, PICKUP, GOODS_RECEIPT, MEASUREMENT, SECURITY, or STORAGE.

Agent

The Agent is not allowed to create this resource.

Customer

The Customer is not allowed to create this resource.

Create a new shipment service

post

Create a new shipment service

Authorizations

Body

shipmentstring · uuidRequired

quantitynumber | nullableRequired

isDonebooleanRequired

typestring · uuidRequired

Responses

201Success

application/json

400

Bad Request

application/json

401

Unauthorized Entity

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

post

HTTPcURLJavaScriptPython

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

{
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "isDone": true,
  "type": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "type": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "isDone": true,
  "createdAt": null,
  "updatedAt": null
}