Saltar al contenido principal

Order

order?: Order

The current order state, containing order status, tracking statuses, and additional metadata. This property is only available on the checkout success page after the order has been completed, and will be undefined on all other pages.

PropertyTypeAlways presentDescription
status"open" or "closed" or "cancelled" or nullNoStatus of the order.
tracking_statusesOrderTrackingStatus[]NoTracking statuses of the order.
extraRecord\<string, string>NoAdditional metadata for the order, set by partner apps.

OrderTrackingStatus (each element of order.tracking_statuses):

PropertyTypeAlways presentDescription
type"shipped" or "packed" or "shipping_failure"YesType of the tracking status.
titlestringYesTitle of the tracking status.
timestampstringYesTimestamp of the tracking status.

To set order.extra from your app, dispatch the order:add:extra event.

For the exact TypeScript definitions, use the types from @tiendanube/nube-sdk-types (e.g. Order, OrderTrackingStatus).

Help us improve NubeSDK

Found an issue or have a suggestion? Let us know on GitHub.