Return package status changed

Webhook: return-package-status-changed — OMS API · Webhooks

Sent when the status of the return package changes (e.g. shipped, arrived at warehouse). packageId indicates the returned shipment package, returnId indicates the return package.

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: Body is serialized in PascalCase (HookName, PackageId) with null fields omitted for unauthenticated or Basic Auth subscriptions; camelCase for Bearer/API key subscriptions. Read the body case-insensitively.

İstek gövdesi

• items (object[]): Lines in the return package.
  • 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.packageItemReturnRejectReasonId (integer<int64>): If the return was rejected, rejection reason ID.
  • items.packageItemStatusReturnReasonId (integer<int64>): Return reason ID.
  • items.packageItemReturnRejectReasonDesc (string): Rejection description.
  • items.packageItemReturnRejectReasonName (string): Rejection reason name.
  • items.packageItemStatusReturnReasonDesc (string): Return description.
  • items.packageItemStatusReturnReasonName (string): Return reason name.
• orderId (string): The orderId value you sent for the order.
• cargoKey (string): Shipping key.
• hookName (string): Event name. If an alias is defined in the subscription, that name is sent.
• returnId (string): Return package ID.
• packageId (string): The package's sourcePackageId value.
• invoiceLink (string): Invoice link.
• packageType (string): Package type.
• trackingCode (string): Shipping tracking number.
• estimatedDate (string<date-time>): Time of the last status change.
• invoiceNumber (string): Invoice number.
• packageStatusId (integer<int32>): Package status ID.
• parentPackageId (string): If the package is from a split/partial cancellation, the source package ID; otherwise, the package's own ID.
• cargoCompanyName (string): Shipping company name.
• cargoTrackingUrl (string): Shipping tracking link.
• packageStatusName (string): Package status name (see OrderPackageStatus).
• packageStatusUser (string): Name of the user who changed the status.
• estimatedDateTimestamp (integer<int64>): Unix timestamp (milliseconds) of the estimatedDate value.

Yanıtlar

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