Orders

Changed on

Partially update an order owned by the current company.

patch/api/orders/{id}

Request

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/orders/{id}
  • Auth
    none declared

Path parameters

idstring required

Request body

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

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

  • bd8a92f5afd9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 26dc623d4f5bRevision changes
    • warning

      removed the request property

    • info

      added the optional property / to the response with the status