Purchase a shipping label for a previously-quoted rate

curl -X POST https://marketplace.walmart.com/seller/v1/shipping/v4/shipments \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "requestToken": "string",
  "rateId": "string",
  "requestedDocumentSpecification": {
    "format": "PDF",
    "size": {},
    "dpi": 203
  }
}'

{
  "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"
      }
    }
  }
}

Purchases the shipping label for the rate selected from a prior getRates response. Returns the shipment record with label document references.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

requestTokenstringRequired

requestToken returned by the prior getRates response.

rateIdstringRequired

The chosen rateId from the getRates response.

requestedDocumentSpecificationobjectRequired

requestedValueAddedServiceslist of objectsOptional

additionalInputsmap from strings to anyOptional

Carrier/service-specific inputs validated against the schema returned by getAdditionalInputs.

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