Split the package into groups

POST /OrderPackage/shipment-packages/{shipmentPackageId}/multi-split — OMS API · Package Splitting

Splits the package into multiple packages in a single request; each splitGroups element becomes a separate package. Do not write all lines in the package into groups: the system automatically creates a separate package for lines not written into groups. For example, when groups [1,2] and [3] are given, three packages are created including the remaining lines.

Splitting completes asynchronously: fetch packages again with GetOrderPackages to see the new packages.

Parametreler

  • shipmentPackageId (path, integer<int64>, zorunlu): OMS ID of the package to split (the id in the GetOrderPackages response; not sourcePackageId).

İstek gövdesi

  • splitGroups (object[], zorunlu): Each group becomes a separate package. The system also creates a package for lines not written into groups.
    • splitGroups.orderLineIds (integer<int64>[], zorunlu): OMS IDs of the lines in this group.

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 fields are invalid.
  • 401: Authorization header missing, token invalid or expired. The body is empty; get a new token via /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 succeeded. Can be false even if HTTP 200 is returned; check in every response.
  • statusCode (integer<int32>, zorunlu): Status code. Usually 0 for successful responses; should not be used instead of the 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.