Cancellation request approved

Webhook: cancel-request-approved — OMS API · Webhooks

Sent when the request you opened with Create cancellation request is approved by the seller. items contains the approved line, packageStatusName always carries the value Cancelled.

Delivery: OMS sends a POST to the address defined in the subscription. Responses other than 2xx are considered failures and retried up to the number of attempts in the subscription; the same event may occur multiple times, make processing safely repeatable (idempotent).

Field names: The body is serialized in PascalCase (HookName, PackageId) without authentication or with Basic Auth subscriptions, skipping null fields; with Bearer/API key subscriptions, it is serialized in camelCase. Read the body case-insensitively.

İstek gövdesi

  • items (object[]): The line of the finalized cancellation request (single element).
    • items.orderItemLineId (string): The sourceOrderItemLineId value you sent for the line.
    • items.packageItemStatusId (integer<int32>): Line status ID.
    • items.packageItemStatusName (string): Line status name.
    • items.packageItemStatusReasonId (integer<int64>): Cancellation reason ID on approval, rejection reason ID on denial.
    • items.packageItemStatusReasonDesc (string): Reason description.
    • items.packageItemStatusReasonName (string): Reason name.
    • items.packageItemCancelApproveDesc (string): Approval explanation (only in approval event).
  • orderId (string): The orderId value you sent for the order.
  • hookName (string): Event name.
  • packageId (string): The sourcePackageId value of the package.
  • packageType (string): Package type.
  • packageStatusId (integer<int32>): Package status ID.
  • parentPackageId (string): If the package was split/partially cancelled, the ID of the source package; otherwise, the package's own ID.
  • packageStatusName (string): Package status name (see OrderPackageStatus).
  • packageStatusUser (string): Name of the user who changed the status.

Yanıtlar

  • 200: Confirm receipt of the notification with 2xx; the body is not read.
  • 500: Any response other than 2xx is considered a failure and retried.