Cancels a shipment and returns the pre-paid shipping label

Deprecated

DELETE

/mfn/v4/shipments/:shipmentId

DELETE

/seller/v1/mfn/v4/shipments/:shipmentId

curl -X DELETE https://marketplace.walmart.com/seller/v1/mfn/v4/shipments/shipmentId \
     -H "Authorization: Bearer <token>"

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

Authentication

AuthorizationBearer

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

Path parameters

shipmentIdstringRequired

Response

Shipment cancelled

payloadobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error