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
  1. REST API
  2. Shipment Operator

Create a shipment operator

PreviousGet shipment operator by idNextUpdate a shipment operator

Last updated 1 year ago

Create a new shipment operator

post

Create a new shipment operator

Authorizations
Body
shipmentstring · uuidRequired
codestring · enumRequiredPossible values:
addressstring | nullableRequired
addressComplementarystring | nullableRequired
postalCodestring | nullableRequired
citystring | nullableRequired
namestring | nullableRequired
contactstring | nullableRequired
emailstring · email | nullableRequired
telstring | nullableRequired
faxstring | nullableRequired
phonestring | nullableRequired
agreementNumberstring | nullableRequired
agreementValidityany | nullableRequired
societystring | nullableRequired
countrystring · enum | nullableRequiredPossible values:
Responses
post
POST /shipment-operator HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "code": "CONSIGNEE",
  "address": "text",
  "addressComplementary": "text",
  "postalCode": "text",
  "city": "text",
  "name": "text",
  "contact": "text",
  "email": "name@gmail.com",
  "tel": "text",
  "fax": "text",
  "phone": "text",
  "agreementNumber": "text",
  "agreementValidity": null,
  "society": "text",
  "country": "AD",
  "comments": [
    {
      "comment": "text",
      "societies": [
        {
          "society": "text"
        }
      ]
    }
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "shipment": "123e4567-e89b-12d3-a456-426614174000",
  "society": "text",
  "country": "AD",
  "code": "CONSIGNEE",
  "address": "text",
  "addressComplementary": "text",
  "postalCode": "text",
  "city": "text",
  "name": "text",
  "contact": "text",
  "email": "name@gmail.com",
  "tel": "text",
  "fax": "text",
  "phone": "text",
  "agreementNumber": "text",
  "agreementValidity": null,
  "createdAt": null,
  "updatedAt": null
}