--- updatedAt: 2026-08-03T18:06:26.000Z --- # Get Shipping Template Details

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


[block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "version": "1.0", "title": "Settings Management", "description": "Settings Management API." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false, "explorer-enabled": true }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" } ], "paths": { "/v3/ca/settings/shipping/templates/{templateId}": { "get": { "tags": [ "Settings" ], "summary": "Get Shipping Template Details", "description": "

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


", "externalDocs": { "description": "View Guide", "url": "/doc/ca/mp/ca-mp-settings/#4777" }, "operationId": "getShippingTemplateDetails", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "string" } }, { "name": "WM_MARKET", "in": "header", "schema": { "type": "string", "enum": [ "ca" ] } }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "description": "A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Walmart Service Name", "required": true, "schema": { "type": "string" }, "example": "Walmart Service Name" }, { "name": "WM_SEC.TIMESTAMP", "in": "header", "description": "The Epoch timestamp", "required": true, "schema": { "type": "string" }, "example": "1443748249449" }, { "name": "WM_SEC.AUTH_SIGNATURE", "in": "header", "description": "The vendor's digital signature, generated by running the JAR file or custom generation code", "required": true, "schema": { "type": "string" }, "example": "9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=" }, { "name": "WM_CONSUMER.ID", "in": "header", "description": "A unique ID required to access the API", "required": true, "schema": { "type": "string" }, "example": "Get the Consumer ID from Developer Center after logging in" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "required": [ "name", "rateModelType", "shippingMethods", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Shipping Template ID" }, "name": { "pattern": "^[A-Za-z0-9\\s]+$", "type": "string", "description": "Shipping Template Name" }, "type": { "type": "string", "description": "Shipping Template Type, can be CUSTOM or DEFAULT.", "enum": [ "DEFAULT", "CUSTOM" ] }, "rateModelType": { "type": "string", "description": "This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order", "enum": [ "TIERED_PRICING", "PER_SHIPMENT_PRICING" ] }, "status": { "type": "string", "description": "Shipping Template Status.Will always be ACTIVE only", "enum": [ "ACTIVE" ] }, "shippingMethods": { "type": "array", "description": "Array of different ship methods of a Shipping Template", "items": { "required": [ "configurations", "shipMethod", "status" ], "type": "object", "properties": { "shipMethod": { "type": "string", "description": "| Attribute | Description | Data Type |\n| ---- | ----------------- | ------- |\n| EXPRESS | All Marketplace Sellers must offer Value shipping to Walmart.com customers for items that can't ship within expected transit times for standard shipping. | string |\n| STANDARD | You are required to offer standard shipping to Walmart.com customers. | string |\n", "enum": [ "EXPRESS", "STANDARD" ] }, "status": { "type": "string", "description": "Shipping Method Status, Should be ACTIVE for Standard and ACTIVE/INACTIVE for Express", "enum": [ "ACTIVE", "INACTIVE" ] }, "configurations": { "type": "array", "description": "Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge", "items": { "required": [ "addressTypes", "minTransitTime", "regions", "transitTime" ], "type": "object", "properties": { "regions": { "type": "array", "description": "Supported Regions", "items": { "required": [ "regionCode" ], "type": "object", "properties": { "regionCode": { "type": "string" }, "regionName": { "type": "string" } }, "description": "Supported Regions" } }, "addressTypes": { "type": "array", "description": "Supported address types.Can be only PO_BOX,STREET", "items": { "type": "string", "description": "Supported address types.Can be only PO_BOX,STREET", "enum": [ "PO_BOX", "STREET" ] } }, "transitTime": { "type": "integer", "description": "Time in transit", "format": "int32" }, "perShippingCharge": { "required": [ "unitOfMeasure" ], "type": "object", "properties": { "unitOfMeasure": { "type": "string", "description": "Unit of Measure eg. LB" }, "shippingAndHandling": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The numerical amount for that charge. Example: 9.99" }, "currency": { "type": "string", "description": "The type of currency for the charge. Example: MXN" } }, "description": "Shipping and Handling Charge" }, "chargePerWeight": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Charge Per weight, value CAD" }, "currency": { "type": "string", "description": "Currency, eg. CAD" } }, "description": "Per Item Charge" }, "chargePerItem": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Charge Per Item, value CAD" }, "currency": { "type": "string", "description": "Currency, eg. CAD" } }, "description": "Per Weight Charge" } }, "description": "Charge per shipping" }, "tieredShippingCharges": { "type": "array", "description": "Tiered Shipping Charges", "items": { "required": [ "maxLimit", "minLimit" ], "type": "object", "properties": { "minLimit": { "type": "number", "description": "Minimum Limit" }, "maxLimit": { "type": "number", "description": "Maximum Limit" }, "shipCharge": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Charge Per Item, value MXN" }, "currency": { "type": "string", "description": "Currency, eg. MXN" } }, "description": "Details of Shipping Charge" } }, "description": "Tiered Shipping Charges" } }, "minTransitTime": { "type": "integer", "description": "minTime in transit", "format": "int32" } }, "description": "Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge" } } }, "description": "Array of different ship methods of a Shipping Template" } }, "createdBy": { "type": "string" }, "modifiedBy": { "type": "string" }, "createdDate": { "type": "number" }, "modifiedDate": { "type": "number" } } }, "example": { "name": "Template 1", "type": "CUSTOM", "rateModelType": "PER_SHIPMENT_PRICING", "status": "ACTIVE", "shippingMethods": [ { "shipMethod": "EXPRESS", "status": "ACTIVE", "configurations": [ { "regions": [ { "regionCode": "2001", "regionName": "Greater Toronto" } ], "addressTypes": [ "STREET" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 6, "currency": "CAD" }, "chargePerItem": { "amount": 4, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3017", "regionName": "Urban Ontario" } ], "addressTypes": [ "STREET" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 8, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3023", "regionName": "Rural Quebec" } ], "addressTypes": [ "STREET" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3018", "regionName": "Urban Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 8, "minTransitTime": 2, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 6, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3020", "regionName": "Rural Ontario - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 5, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3024", "regionName": "Rural Quebec - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 4, "minTransitTime": 3, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "CAD" }, "chargePerItem": { "amount": 2, "currency": "CAD" } } }, { "regions": [ { "regionCode": "2006", "regionName": "Urban British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 2, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3006", "regionName": "Rural British Columbia - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 6, "minTransitTime": 4, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 1, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } }, { "regions": [ { "regionCode": "3008", "regionName": "Urban Prairies (MB, SK, AB) - PO Box" } ], "addressTypes": [ "PO_BOX" ], "transitTime": 3, "minTransitTime": 1, "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "CAD" }, "chargePerItem": { "amount": 1, "currency": "CAD" } } } ] } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string" }, "category": { "type": "string" }, "errorIdentifiers": { "type": "object", "properties": { "entry": { "type": "array", "items": { "type": "object" } } } } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string" }, "category": { "type": "string" }, "errorIdentifiers": { "type": "object", "properties": { "entry": { "type": "array", "items": { "type": "object" } } } } } } } } } } } } } } } ```