API Reference
My Account

Package Shipped Message Notification Webhook

post
https://developer.api.us.stg.walmart.com/<package_shipped event>

This webhook request notifies recipients that the ordered items were shipped.

This webhook is used when the packing module is enabled.

Use of this webhook requires the integrator to provide an endpoint. Webhook events are published to client-provided endpoints.

Body Params
string
required

The type of the event.

Example

PACKAGE_SHIPPED

date-time
required

A date-timestamp that indicates the generation time of the event, in ISO 8601 format.

Example

2024-01-02T08:16:36.123Z

string
required

The identifier of the customer order.

A single customer order could contain multiple items, and those items could be sourced from different stores. For this reason, tenants can distribute items that are associated with a single customer order (CO) identifier across multiple purchase order (PO) numbers that reflect the different stores and order types.

Example

MAK1234567

string
required

The identifier of a tenant order.

Example

59419201

date-time
required

A date-timestamp that indicates the time of shipping, in ISO 8601 format.

Example

2024-01-08T08:16:36.000Z

packageDetail
array of objects
required

An array of values that provide information about a package, including package ID and tracking number.

packageDetail*
Headers
int64
required

Specifies the tenant identifier.

int64
required

Specifies the store identifier.

string

Specifies the consumer identifier provided by tenants for accessing requests and webhooks.

Walmart Supply Chain as a Service (WSCaaS) will stamp the client identifier based on the consumer identifier.

Example

2d6cf199-9b07-4350-bb2b9-0db3c2

string
required

Specifies the literal application/json.

Example

application/json

Response
200

The FAAS_PACKAGE_SHIPPED message was successfully sent.

Updated about 1 year ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated about 1 year ago