Provides the full details of a shipment within an inbound plan.

GET

/inbound/wfs/v4/inboundPlans/:inboundPlanId/shipments/:shipmentId

GET

/seller/v1/inbound/wfs/v4/inboundPlans/:inboundPlanId/shipments/:shipmentId

curl https://marketplace.walmart.com/seller/v1/inbound/wfs/v4/inboundPlans/inboundPlanId/shipments/shipmentId \
     -H "Authorization: Bearer <token>"

{
  "destination": {
    "destinationType": "string",
    "address": {
      "addressLine1": "string",
      "city": "string",
      "countryCode": "string",
      "name": "string",
      "postalCode": "string",
      "addressLine2": "string",
      "companyName": "string",
      "districtOrCounty": "string",
      "email": "string",
      "phoneNumber": "string",
      "stateOrProvinceCode": "string"
    },
    "warehouseId": "string"
  },
  "placementOptionId": "string",
  "shipmentId": "string",
  "source": {
    "sourceType": "string",
    "address": {
      "addressLine1": "string",
      "city": "string",
      "countryCode": "string",
      "name": "string",
      "postalCode": "string",
      "addressLine2": "string",
      "companyName": "string",
      "districtOrCounty": "string",
      "email": "string",
      "phoneNumber": "string",
      "stateOrProvinceCode": "string"
    }
  },
  "contactInformation": {
    "name": "string",
    "phoneNumber": "string",
    "email": "string"
  },
  "dates": {
    "readyToShipWindow": {
      "end": "2024-01-15T09:30:00Z",
      "start": "2024-01-15T09:30:00Z",
      "editableUntil": "2024-01-15T09:30:00Z"
    }
  },
  "freightInformation": {
    "declaredValue": {
      "amount": 1.1,
      "code": "string"
    },
    "freightClass": "string"
  },
  "name": "string",
  "selectedDeliveryWindow": {
    "availabilityType": "string",
    "deliveryWindowOptionId": "string",
    "endDate": "2024-01-15T09:30:00Z",
    "startDate": "2024-01-15T09:30:00Z",
    "editableUntil": "2024-01-15T09:30:00Z"
  },
  "selectedTransportationOptionId": "string",
  "selfShipAppointmentDetails": [
    {
      "appointmentId": 1.1,
      "appointmentSlotTime": {
        "endTime": "2024-01-15T09:30:00Z",
        "startTime": "2024-01-15T09:30:00Z"
      },
      "appointmentStatus": "string"
    }
  ],
  "shipmentConfirmationId": "string",
  "status": "string",
  "trackingDetails": {
    "ltlTrackingDetail": {
      "billOfLadingNumber": "string",
      "freightBillNumber": [
        "string"
      ]
    },
    "spdTrackingDetail": {
      "spdTrackingItems": [
        {
          "boxId": "string",
          "trackingId": "string",
          "trackingNumberValidationStatus": "string"
        }
      ]
    }
  }
}

Path parameters

inboundPlanIdstringRequired

Identifier of an inbound plan.

shipmentIdstringRequired

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

Response

Success

destinationobject

The Walmart Ship Node address and warehouse ID.

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

The identifier of a placement option.

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

Identifier of a shipment.

sourceobject

Specifies the 'ship from' address for the shipment.

contactInformationobjectOptional

The seller's contact information.

datesobjectOptional

Specifies the date that the seller expects their shipment will be shipped.

freightInformationobjectOptional

Freight information describes the SKUs that are in transit.

namestringOptional

The name of the shipment.

selectedDeliveryWindowobjectOptional

Selected delivery window attributes.

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

Identifier of a transportation option.

selfShipAppointmentDetailslist of objectsOptional

List of self ship appointment details.

shipmentConfirmationIdstringOptional1-1024 characters

The confirmed shipment ID which shows up on labels.

statusstringOptional1-1024 characters

The status of a shipment. Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING.

trackingDetailsobjectOptional

Tracking information for LTL and SPD shipments.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error