Return request completed (approval)

Webhook: return-request-confirmed — OMS API · Webhooks

Sent when the return package is evaluated by the seller. Decisions are made per line: approved lines come with Returned, rejected ones with ReturnRequestDenied status.

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

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

İstek gövdesi

  • items (object[]): Lines in the return package. In approval events, lines come with Returned or ReturnRequestDenied status.
    • 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>): Return reason ID on approval, rejection reason ID on denial.
    • items.packageItemStatusReasonDesc (string): Reason description.
    • items.packageItemStatusReasonName (string): Reason name.
  • 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 created by splitting/partial cancellation, the source package ID; 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 a 2xx; the body is not read.
  • 500: Any response other than 2xx is considered a failure and retried.