Tradecloud API v2 manual
  • Introduction
    • Welcome
      • Checklist
      • Support
    • API
      • Rules
      • Requests
      • JSON versus XML
      • Environments
      • Standards
      • Compatibility
      • Tools
        • Swagger UI
        • Postman
        • .NET SDK
      • Webhook versus polling
        • Polling usage
        • Polling echo
      • Delivery schedule
    • Security
      • Security overview
      • Authentication
      • Authorization
      • Encryption
      • Document storage
  • Guide
    • 1. Getting an Account
    • 2. Sending your first order
      • Option A: Sending a Delivery Schedule per order line
      • Option B: Sending a Single Delivery per order line
  • Processes
    • Forecasts
      • Issue a new forecast
      • Issue a new Slimstock forecast
    • Orders
      • Buyer order process
        • Issue a new order
          • Delivery schedule
          • Indicators
          • No delivery expected
          • Propose when accepted
          • Attach a document to an order
          • Choose attach document API
        • Update an existing order
        • Receive an order response
          • Download a document attached to an order response
          • Single delivery order response
        • Receive goods
        • Complete an order
        • Reopen an order
        • Cancel an order
      • Supplier order process
        • Receive an order
          • Download a document attached to an order
          • Single delivery order
        • Send order response
          • Attach a document to an order response
        • Reopen an order
        • Cancel an order
    • Shipments
      • Supplier shipment process
        • Send despatch advice
      • Buyer shipment process
        • Receive a shipment event
          • Download a document attached to a shipment
Powered by GitBook
On this page
  • Order & line indicators
  • Confirmed by buyer
  • Reconfirmation request by buyer
  • Shipped by supplier
  • Delivered at buyer
  • Completed at buyer
  • Cancelled by buyer
  • Order only indicators
  • Auto confirm
  • Cancel line when missing
  • Order line only indicators
  • No delivery expected
  • Propose when accepted
  • Single delivery order line behavior
  • Indicator behaviors
  1. Processes
  2. Orders
  3. Buyer order process
  4. Issue a new order

Indicators

How to use order and line indicators as a buyer

PreviousDelivery scheduleNextNo delivery expected

Last updated 3 months ago

Order & line indicators

You can set indicators on both order and line levels. Line indicators have precedence over (overrule) order indicators.

When working with the single delivery per order line feature, these indicators behave slightly different, check the .

Confirmed by buyer

confirmed: all goods of this order or line are confirmed by the supplier, according to the buyer.

The order or line must have process status Issued and will become Confirmed. This indicator is only intended for onboarding or migration of order lines which are already confirmed.

Reconfirmation request by buyer

requestReconfirmation: the supplier is requested to reconfirm the order line. The supplier either reconfirms the order line with requested values or alternatively does a reopen request with different values.

The order or line must have process status Confirmed and will become InProgress. The inProgressStatus will become OpenBuyerReconfirmationRequest

Shipped by supplier

shipped: all goods of this order or line are completely shipped by the supplier, according to the buyer.

The order or line having logistics status Open, Produced, ReadyToShip will become Shipped.

Delivered at buyer

delivered: all goods of the order or line are completely delivered at the buyer.

The order or line having logistics status Open, Produced, ReadyToShip or Shipped will become Delivered.

Completed at buyer

completed: the order or line is completed at the buyer. Usually this indicator is set when the invoice is received and approved by buyer.

  • Issued, In progress, Rejected and Confirmed lines will become Completed.

  • Cancelled lines cannot be completed.

  • Completed lines cannot be completed again.

  • Completing has precedence over cancelling at the same time.

Cancelled by buyer

cancelled: the order or line is cancelled by the buyer.

  • Issued, In Progress, Rejected and Confirmed lines will become Cancelled immediately.

  • Completed lines cannot be cancelled.

  • Cancelled lines cannot be cancelled again.

Order only indicators

Auto confirm

autoConfirm: If this flag is set to true then the order lines will be automatically confirmed in case of a supplier proposal or reopen request.

Cancel line when missing

cancelLineWhenMissing: If this flag set to true and existing order lines positions are not present among incoming lines then they will be cancelled.

  • Issued, In Progress, Rejected and Confirmed lines will become Cancelled immediately.

  • Completed lines cannot be cancelled.

  • Cancelled lines cannot be cancelled again.

Order line only indicators

No delivery expected

noDeliveryExpected: no goods of are expected to be delivered to the buyer.

Propose when accepted

proposeWhenAccepted: If this flag is set to true then this line becomes automatically a supplier proposal in case the supplier the accepts a line.

Single delivery order line behavior

How indicators work with single delivery per order line:

When using the single delivery per order line feature, Tradecloud manages related lines through the originalPosition reference. This affects how indicators behave:

Indicator behaviors

Indicator
Behavior with single delivery

confirmed

When all primary and related split lines are confirmed; the primary order line will become confirmed

requestReconfirmation

When set on the primary or any related split line the primary order line will open a reconfirmation request

shipped

When the primary or any related split lines is shipped; the corresponding delivery line will become shipped

delivered

When the primary or any related split lines is delivered; the corresponding delivery line will become delivered

completed

When all primary and related split lines are completed; the primary order line will become completed

cancelled

When all primary and related split lines are cancelled; the primary order line will become cancelled. When an individual order line is cancelled; Tradecloud will remove the split line from the orginal line's delivery schedule

proposeWhenAccepted

When set on the primary or any related split line; the primary order line will open a proposal request when accepted

The /order/indicators endpoint is not supported when using the single delivery feature. Let know when you need this endpoint for single delivery.

No delivery expected
Propose when accepted
support
single delivery order line behavior