Purchases shipping and returns a shipping label

Deprecated

POST

/mfn/v4/shipments

POST

/seller/v1/mfn/v4/shipments

curl -X POST https://marketplace.walmart.com/seller/v1/mfn/v4/shipments \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "shipmentRequestDetails": {
    "purchaseOrderId": "string",
    "shipFromAddress": {
      "name": "string",
      "addressLine1": "string",
      "city": "string",
      "stateOrRegion": "string",
      "postalCode": "string",
      "countryCode": "US"
    },
    "shipToAddress": {
      "name": "string",
      "addressLine1": "string",
      "city": "string",
      "stateOrRegion": "string",
      "postalCode": "string",
      "countryCode": "US"
    },
    "packageDimensions": {
      "length": 1.1,
      "width": 1.1,
      "height": 1.1,
      "unit": "inches"
    },
    "weight": {
      "value": 1.1,
      "unit": "oz"
    },
    "shipDate": "2024-01-15T09:30:00Z",
    "shippingServiceOptions": {}
  },
  "shippingServiceId": "string"
}'

{
  "shipment": {
    "shipmentId": "string",
    "shipmentStatus": "PURCHASED",
    "orderId": "string",
    "sellerOrderId": "string",
    "itemList": [
      {
        "quantity": 1,
        "orderItemId": "string"
      }
    ],
    "shipFromAddress": {
      "name": "string",
      "addressLine1": "string",
      "city": "string",
      "stateOrRegion": "string",
      "postalCode": "string",
      "countryCode": "US",
      "addressLine2": "string",
      "addressLine3": "string",
      "county": "string",
      "district": "string",
      "municipality": "string",
      "phone": "string",
      "isCommercialAddress": true
    },
    "shipToAddress": {
      "name": "string",
      "addressLine1": "string",
      "city": "string",
      "stateOrRegion": "string",
      "postalCode": "string",
      "countryCode": "US",
      "addressLine2": "string",
      "addressLine3": "string",
      "county": "string",
      "district": "string",
      "municipality": "string",
      "phone": "string",
      "isCommercialAddress": true
    },
    "packageDimensions": {
      "length": 1.1,
      "width": 1.1,
      "height": 1.1,
      "unit": "inches"
    },
    "weight": {
      "value": 1.1,
      "unit": "oz"
    },
    "insurance": {
      "amount": "string",
      "currencyCode": "USD"
    },
    "shippingService": {
      "shippingServiceId": "string",
      "carrierName": "UPS",
      "shippingServiceOfferId": "string",
      "shippingServiceName": "string",
      "shipDate": "2024-01-15T09:30:00Z",
      "earliestEstimatedDeliveryDate": "2024-01-15T09:30:00Z",
      "latestEstimatedDeliveryDate": "2024-01-15T09:30:00Z",
      "rate": {
        "amount": "string",
        "currencyCode": "USD"
      },
      "shippingServiceOptions": {
        "deliveryExperience": "DeliveryConfirmationWithAdultSignature",
        "carrierWillPickUp": true,
        "carrierWillPickUpOption": "CarrierContact",
        "declaredValue": {
          "amount": "string",
          "currencyCode": "USD"
        }
      }
    },
    "label": {
      "customTextForLabel": "string",
      "dimensions": {
        "length": 1.1,
        "width": 1.1,
        "unit": "inches"
      },
      "fileContents": {
        "contents": "string",
        "fileType": "application/pdf",
        "checksum": "string"
      },
      "labelFormat": "PDF",
      "standardIdForLabel": "WalmartOrderId"
    },
    "createdDate": "2024-01-15T09:30:00Z",
    "lastUpdatedDate": "2024-01-15T09:30:00Z"
  }
}

Creates a shipment for an order, purchases a shipping label from the selected carrier, and returns the label for printing.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

shipmentRequestDetailsobjectRequired

shippingServiceIdstringRequired

shippingServiceOfferIdstringOptional

labelFormatenumOptional

Response

Success

shipmentobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error