Skip to end of banner
Go to start of banner

Update Order Properties API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Inbound | PUTĀ  | /orders/{orderCode}

Summary

This API is used to update the properties of an order.

Description

This API is used to update the Dispatch by time and start processing time usually when the orders are Unhold.

Request

{
  "dispatchByTime": "2022-10-17T20:22:28.000+00:00",
  "locationCode": "string",
  "onHold": true,
  "startProcessingTime": "2022-10-16T20:22:28.000+00:00",
  "deliveredAt": "2022-10-30T20:22:28.000+00:00",
  "orderStatus": "DELIVERED"
}

Parameter Name

Data Type

Description

Mandatory

dispatchByTime

String

Time by which the order is expected to get dispatched

yes

locationCode

String

Code used by channels to identify a warehouse

no

onHold

Boolean

This flag is true in case order has to be kept on hold. Processing starts only after call is made to unhold the order

yes

startProcessingTime

String

Time by which the order processing is expected to get started

yes

deliveredAt

String

Time when the order get delivered to the customer(mandatory when order status is sent as DELIVERED)

no

orderStatus

String

To be sent as delivered to update the status as delivered on WMSPossible values(DELIVERED/CREATED)

no

Response

Empty Body

HttpStatus : 200

  • No labels