Fetches the details of an inbound plan.

{
  "createdAt": "2024-01-15T09:30:00Z",
  "inboundPlanId": "string",
  "lastUpdatedAt": "2024-01-15T09:30:00Z",
  "marketplaceIds": [
    "string"
  ],
  "name": "string",
  "sourceAddress": {
    "addressLine1": "string",
    "city": "string",
    "countryCode": "string",
    "name": "string",
    "postalCode": "string",
    "addressLine2": "string",
    "companyName": "string",
    "districtOrCounty": "string",
    "email": "string",
    "phoneNumber": "string",
    "stateOrProvinceCode": "string"
  },
  "status": "string",
  "packingOptions": [
    {
      "packingOptionId": "string",
      "status": "string"
    }
  ],
  "placementOptions": [
    {
      "placementOptionId": "string",
      "status": "string"
    }
  ],
  "shipments": [
    {
      "shipmentId": "string",
      "status": "string"
    }
  ]
}

Path parameters

inboundPlanIdstringRequired

Identifier of an inbound plan.

Response

Success

createdAtdatetime

The time at which the inbound plan was created. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

inboundPlanIdstringformat: "^[a-zA-Z0-9-]*$"=38 characters

Identifier of an inbound plan.

lastUpdatedAtdatetime

The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

marketplaceIdslist of strings

A list of Walmart marketplace IDs.

namestring

Human-readable name of the inbound plan.

sourceAddressobject

Specific details to identify a place.

statusstring1-1024 characters

Current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

packingOptionslist of objectsOptional

Packing options for the inbound plan. Populated after generation via the corresponding operation.

placementOptionslist of objectsOptional

Placement options for the inbound plan. Populated after generation via the corresponding operation.

shipmentslist of objectsOptional

A list of shipment IDs for the inbound plan. Populated after confirmPlacementOptions.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error