Write order client status

POST /Orders/SetOrderClientStatus — OMS API · Orders

Writes the processing status (client status) of the order and all its packages in your own system. The body is an array; you can send multiple records in a single request.

When to call: After you have received the pulled order into your own system; so it does not appear again in the next pull with the clientStatus filter.

  • status is free text; it does not change the OMS package status.
  • Order numbers not found are silently skipped.
  • Client status of packages changed after pulling is not updated (remains Created for re-pulling).

İstek gövdesi

  • status (string, zorunlu): Processing status in your own system (free text), e.g. Received.
  • message (string): Optional description.
  • sourceOrderNumber (string, zorunlu): The orderNumber value of the order.

Yanıtlar

  • 200: Successful. Always check the isSuccess field in the body.
  • 400: Body validation failed (missing required field, type mismatch, or malformed JSON). The response is in ASP.NET Core ValidationProblemDetails format; the errors field indicates which field is invalid.
  • 401: Authorization header missing, token invalid or expired. The body returns empty; get a new token with /Auth/login.
  • 500: Unexpected server error. This response returns with PascalCase field names (unlike other responses) and includes null fields.

200 yanıt alanları

  • errors (object[]): Detailed error list. Returned only if present.
    • errors.code (string): Error code.
    • errors.message (string): Error message.
  • isSuccess (boolean, zorunlu): true if the operation is successful. Can be false even if HTTP 200 is returned; check every response.
  • statusCode (integer<int32>, zorunlu): Status code. Usually 0 in successful responses; should not be used instead of HTTP status code.
  • errorSource (string): Error source. Returned only if present.
  • correlationId (string): Request tracking ID. Returned only if present.
  • errorMesssage (string): Error message (field name is spelled with three s in the source). Returned only if there is an error.