Authentication

Sections

GET
Authentication
Shipping Management
Addresses
- Senders
- Receivers
Shipments
- Pdfs
- POST
  Create Shipment
- GET
  Fetch Shipment
- DELETE
  Delete Shipment
- {shipmentId}
  - Prints
- POST
  /Shipments/events
Shipment Manifests
- POST
  Create Shipment Manifest
- GET
  Fetch Shipment Manifest
- GET
  Fetch Shipment Manifest Documents
- GET
  Fetch Shipment Manifest PDF
- GET
  Fetch Filtered Shipment Manifest
- GET
  Fetch Printed Shipment Manifest
- GET
  List Shipment Manifest PDFs
- POST
  Create Shipment Manifest Copy
Stored Shipments
- POST
  Create Stored Shipment
- GET
  Lists Stored Shipments
- DELETE
  Delete Stored Shipment
- PUT
  Replace Stored Shipment
- GET
  Fetch Stored Shipment
- POST
  Create Shipment from Stored Shipment
Consolidated Shipments
- POST
  Create Consolidated Shipment
- GET
  List Open Consolidated Shipments
- DELETE
  Delete Parcel Group
- DELETE
  Delete Consolidated Shipment
- GET
  List PDFs
- GET
  Fetch PDF
Shipment Waybills
- GET
  List Shipment Waybill
- {waybillId}
  - GET
    Fetch Shipment Waybill
  - POST
    Create Shipment Waybill
Shipment History
- GET
  Fetch Shipment History
Print
- Clients
  - GET
    List Print Clients
  - {clientId}
    - GET
      Fetch Print Client
    - GET
      List Printers
- POST
  Create Print Job
- Printers
  - GET
    Get Printers
  - GET
    Get Printers PrinterId
- Printjobs
  - GET
    List Print Jobs
  - GET
    Fetch Print Job
- POST
  Create Manifest Print Job
- POST
  Create Shipment Print Job
Prices
- POST
  Fetch Shipment Price
- POST
  Fetch Price History
Status Events
- GET
  Fetch Status Events
Code Lists
- Lists
  - GET
    Fetch Code Lists
Onboarding
- GET
  Fetch Accounts
- Applications
  - POST
    Create Applications
  - GET
    Fetch Application Language
- GET
  Fetch Onboarding Language
Order Management
Comments
- POST
  Create Comment
- DELETE
  Delete Comment
- GET
  Fetch Comment
Delivery Options
- POST
  Create Delivery Option
- PUT
  Update Delivery Option
- DELETE
  Delete Delivery Option
- GET
  Fetch Delivery Option
- GET
  List Delivery Option
- POST
  Get Delivery Option Rates
- POST
  Create Delivery Option PUDO
Order Channels
- POST
  Create Order Channel
- PATCH
  Update Order Channel
- DELETE
  Delete Order Channel
- GET
  Fetch Order Channel
- GET
  Fetch Order Channel Types
- GET
  List Order Channels
- PUT
  /order-channels/{id}
Orders
- POST
  Create Order
- PUT
  Update Order
- DELETE
  Delete Order
- GET
  Fetch Order
- GET
  List Orders
- PUT
  Update Order Delivery Option
- GET
  Fetch Order Timeline
Shipments
- POST
  Create Shipment
Webhooks
- POST
  Create Webhook
- PATCH
  Update Webhook
- DELETE
  Delete Webhook
- GET
  Fetch Webhooks
- GET
  Fetch Webhook by ID
- GET
  Fetch Webhook Events
- GET
  Fetch Webhook Event by ID
- POST
  Test Webhook
- POST
  Resend Webhook
- POST
  Update Webhook Secret

Create Comment

Creates a new comment on an order.

By providing the orderId and type , you can input a text string in value to attach the order.

Returns a comment id.

Body Parameters

orderIdstring | null Required

uuid

typestring | null Required

External or internal

valuestring | null Required

Response

200

Object

Response Attributes

idstring

createdAtstring

authorstring

typeinteger

valuestring