Orders

Create an order for the current company, optionally with nested order lines (created atomically with the order). The order number must be unique within the company for the same order type — a duplicate returns 400 (order_number_already_existing).

post/api/orders/

Request body

orderNumberstring required
orderSubType'STANDARD' | 'REPEAT' | 'COMMIT' | 'SAMPLE' | 'EXTRACTION_SPLIT'
status'IN_PROGRESS' | 'IN_REVIEW' | 'COMPLETED'
tagsstring[]
source'PUBLIC_API' | 'IMPORTER' | 'INTERNAL_API'
buyerCompanyIdstring required
supplierCompanyIdstring required
receiverCompanyIdstring
vendorCompanyIdstring
factorystring
buyerFacilityProcessstring
supplierFacilityProcessstring
receiverFacilityProcessstring
orderDatestring date
deliveryDatestring date
agreedDeliveryDatestring date
expectedShippingDatestring date
shippingDatestring date
handoverDatestring date
actualDeliveryDatestring date
shipmentReferencestring
internalResponsiblePersonsstring[]
counterpartyOrderNumberRefstring
tracingAttachmentTemplateIdstring nullable
orderType'PURCHASE_ORDER' | 'SALES_ORDER' | 'INTERNAL_ORDER' nullable
tracingStatusstring nullable
isArchivedboolean
isAutoboolean

Example request

{
  "orderDate": "2026-07-21",
  "deliveryDate": "2026-07-21",
  "agreedDeliveryDate": "2026-07-21",
  "expectedShippingDate": "2026-07-21",
  "shippingDate": "2026-07-21",
  "handoverDate": "2026-07-21",
  "actualDeliveryDate": "2026-07-21"
}

Response

Default Response

Changes

Changed in 3 of the 49 revisions of this API.49657

  • 97e51f27dc7749654See the full diff
    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ▲

      the request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ●

      the request property's maxLength was set to 36

      request-property-max-length-set

    • ●

      the request property's maxLength was set to 255

      request-property-max-length-set

    • ●

      the // request property's max was set to 100000000000000000.00

      request-property-max-set

    • ●

      the // request property's max was set to 100000000000000000.00

      request-property-max-set

    • ●

      the // request property's min was set to 0.00

      request-property-min-set

    • ●

      the // request property's min was set to 0.00

      request-property-min-set

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      added the new INTERNAL_ORDER enum value to the request property

      request-property-enum-value-added

    • ○

      added the new PURCHASE_ORDER enum value to the request property

      request-property-enum-value-added

    • ○

      added the new SALES_ORDER enum value to the request property

      request-property-enum-value-added

    • ○

      the // request property's exclusiveMaximum was increased from 100000000000000000.00 to true

      request-property-exclusive-max-increased

    • ○

      the // request property's exclusiveMaximum was increased from 100000000000000000.00 to true

      request-property-exclusive-max-increased

    • ○

      the // request property's exclusiveMinimum was decreased from 0.00 to true

      request-property-exclusive-min-decreased

    • ○

      the // request property's exclusiveMinimum was decreased from 0.00 to true

      request-property-exclusive-min-decreased

    • ○

      response property data/actualDeliveryDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/agreedDeliveryDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/buyerFacilityProcess list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/counterpartyOrderNumberRef list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByApiKeyId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByApiKeyLabel list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByCompanyName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByImpersonateId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByImpersonateName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByUserId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/createdByUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/deliveryDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/expectedShippingDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/factory list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/handoverDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lastTracingRequestedAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/lineNo list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/orderLineNumber list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/secondaryQuantity list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/secondaryUnit list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/tracingOrderRequestedAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/lines/items/tracingReflectionOrderId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/orderDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/orderSubType list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/receiverFacilityProcess list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/shipmentReference list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/shippingDate list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/source list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/status list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/supplierFacilityProcess list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/tracingAttachmentTemplateId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/tracingStatus list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedAt list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByApiKeyId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByApiKeyLabel list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByCompanyName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByImpersonateId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByImpersonateName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByUserId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/updatedByUserName list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/vendorCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property / to the response with the status

      response-required-property-added

    • ○

      the request property default value INTERNAL_API was added

      request-property-default-value-added

Of the 49 revisions, 1 has no diff computed.