Write package client status

POST /OrderPackage/SetPackageClientStatus — OMS API · Packages

Writes the transaction status (client status) in your own system to the packages. The body is an array; you can send multiple records in a single request.

When to call: After processing the packages retrieved with GetOrderPackages; to prevent them from appearing again in the next retrieval with the same clientStatus filter.

• status is free text; it does not change the OMS package status.
• Packages not found are silently skipped; packages changed after retrieval are not updated.

İstek gövdesi

• status (string, zorunlu): Transaction status in your own system (free text).
• message (string): Optional description.
• sourcePackageId (string, zorunlu): The package's sourcePackageId value.

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 is empty; get a new token with /Auth/login.
• 500: Unexpected server error. This response returns fields in PascalCase (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. It can be false even if HTTP 200 is returned; check in 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 written with three s in the source). Returned only if there is an error.