Skip to main content

Portal: View Packet

GET 
/api/walmart/:integrationInstance/wfs/inbound-shipments/fulfillment-portal/:token

Load the public fulfilment portal for a WFS inbound packet, resolved by its portal token. Records a 'viewed' portal event and returns the full order summary the 3PL/supplier needs: reference + destination FC, rendered prep instructions, downloadable documents, the kit build manifest (when a build is required), the expected line items, and whether it has been acknowledged as ready.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Public, token-gated endpoint — no bearer auth. The {token} in the path gates packet access; tenant is resolved by host.

Returns 404 with {"message": "This portal link is no longer valid."} when the token is unknown, expired, or revoked.

Response data fields:

  • reference (string): the WFS shipment_id.
  • inbound_order_id (string|null): Walmart inbound order id.
  • source_name (string|null): the source 3PL/supplier warehouse name.
  • source_type (string): '3pl' or 'supplier'.
  • destination_fc (string|null): Walmart ship node / FC.
  • status (string): packet status (draft, sent, in_progress, acknowledged, shipped, send_failed, revoked).
  • build_required (bool): whether component-sourced kits must be assembled.
  • kits_pending_build (bool): a build is required and at least one kit is not yet confirmed built.
  • kit_build_manifest (array): kits to assemble — { sku, name, quantity, components:[{ sku, quantity }] }.
  • instructions (string): rendered plain-text prep instructions (or operator override).
  • line_items (array): { sku, name, image_url, quantity } for every shipment line.
  • documents (array): downloadable documents — { id, type, type_label, stage, status }.
  • acknowledged_at (string|null): ISO-8601 timestamp once acknowledged, else null.

Request​

Responses​

OK

Response Headers
    Content-Type