Package status changed

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

Sent when the status of a shipment package changes (e.g. Picked, Invoiced, Shipped, Delivered, Cancelled). If shipping and invoice information is available, it is added to the body; items carries the current statuses of the lines in the 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: The body is serialized in PascalCase (HookName, PackageId) with null fields omitted for unauthenticated or Basic Auth subscriptions; for Bearer/API key subscriptions, camelCase is used. Read the body case-insensitively.

İstek gövdesi

  • items (object[]): Lines and their statuses in the 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.packageItemCancelReasonId (integer<int64>): Cancellation reason ID if the line was cancelled.
    • items.packageItemCancelReasonDesc (string): Cancellation description.
    • items.packageItemCancelReasonName (string): Cancellation reason name.
    • items.packageItemCancelRejectReasonId (integer<int64>): Rejection reason ID if the cancellation request was rejected.
    • items.packageItemCancelRejectReasonDesc (string): Cancellation request rejection description.
    • items.packageItemCancelRejectReasonName (string): Cancellation request rejection reason name.
  • orderId (string): The orderId value you sent for the order.
  • cargoKey (string): Shipping key.
  • hookName (string): Event name.
  • packageId (string): The sourcePackageId value of the package.
  • invoiceLink (string): Invoice URL.
  • packageType (string): Package type.
  • trackingCode (string): Shipping tracking number.
  • estimatedDate (string<date-time>): Package due date.
  • invoiceNumber (string): Invoice number.
  • packageStatusId (integer<int32>): Package status ID.
  • parentPackageId (string): If the package was created by splitting/partial cancellation, the ID of the source package; otherwise, the package's own ID.
  • cargoCompanyName (string): Shipping company name.
  • cargoTrackingUrl (string): Shipping tracking URL.
  • 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.