Checkin Notification

Checkin provides an inbound API call for status updates to the tenant on various actions in the checkin process, to include start trip, location update, and trip arrived.

Event Name, Trigger, and Webhook Type

The event name, trigger, and webhook type listed below reference how the Checkin Notification Engine (CINE) generates events when clients use Checkin as a Service (ChaaS) requests. If the client application does not use Checkin as a Service (ChaaS), then the client must generate the events listed in the table below and publish said events to Store Assist.

The notification payloads documented in this section are not each explicitly required. Required requests vary based on the client.

Event NameTriggerWebhook Type
First Customer CheckinSignifies the customer trip has begun.START_TRIP
Customer Location UpdateProvides updates for the customer's estimated time of arrival (ETA).LOCATION_UPDATE
Customer ArrivedSignifies that the customer has arrived at the pickup location.TRIP_ARRIVED
Parking UpdatedProvides vehicle and parking location information.PARKING_UPDATE
Path Params
string
required

Specifies the value representing the order for a particular customer order identifier.

Example

2328273

Body Params
header
object

Header information for the check in request.

payload
object

Payload for all relevant information in the check in request

Headers
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 external identifier of the client store.

Example

9221

string
required

Specifies the literal and value for Bearer <authenticationToken>.

Example

Bearer eyJraWQiOiI1N…yLTQ4MjctOGUz

string
required

Specifies the literal application/json.

Example

application/json

string

Specifies an optional parameter to indicate the order mode.

A sample value of TRAINING indicates the order belongs to Training Mode.
See Training Mode Features.
If this header is not present, the order will be treated as a production order.

Example

TRAINING

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json