Quote and purchase a shipment in a single call

POST

/shipping/v4/oneClickShipment

POST

/seller/v1/shipping/v4/oneClickShipment

curl -X POST https://marketplace.walmart.com/seller/v1/shipping/v4/oneClickShipment \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "shipTo": {
    "name": "string",
    "addressLine1": "string",
    "city": "string",
    "stateOrRegion": "string",
    "postalCode": "string",
    "countryCode": "US"
  },
  "shipFrom": {
    "name": "string",
    "addressLine1": "string",
    "city": "string",
    "stateOrRegion": "string",
    "postalCode": "string",
    "countryCode": "US"
  },
  "packages": [
    {
      "dimensions": {
        "length": 1.1,
        "width": 1.1,
        "height": 1.1,
        "unit": "inches"
      },
      "weight": {
        "value": 1.1,
        "unit": "oz"
      },
      "packageClientReferenceId": "string"
    }
  ],
  "serviceSelection": {},
  "requestedDocumentSpecification": {
    "format": "PDF",
    "size": {},
    "dpi": 203
  },
  "channelDetails": {
    "channelType": "WALMART_MARKETPLACE"
  }
}'

{
  "payload": {
    "shipmentId": "string",
    "packageDocumentDetails": [
      {
        "packageClientReferenceId": "string",
        "packageDocuments": [
          {
            "type": "LABEL",
            "format": "PDF",
            "contents": "string"
          }
        ],
        "trackingId": "string"
      }
    ],
    "promise": {
      "deliveryWindow": {
        "start": "2024-01-15T09:30:00Z",
        "end": "2024-01-15T09:30:00Z"
      },
      "pickupWindow": {
        "start": "2024-01-15T09:30:00Z",
        "end": "2024-01-15T09:30:00Z"
      }
    }
  }
}

Convenience endpoint that combines rate quote and purchase into a single round trip when the seller already knows the desired service level. Returns the purchased shipment record directly.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

shipToobjectRequired

shipFromobjectRequired

packageslist of objectsRequired

serviceSelectionobjectRequired

Optional seller-supplied filter to restrict the rate quote to a specific carrier(s) and/or service(s).

requestedDocumentSpecificationobjectRequired

channelDetailsobjectRequired

returnToobjectOptional

shipDatedatetimeOptional

valueAddedServiceslist of objectsOptional

Response

Shipment purchased successfully

payloadobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error