Merchant fulfillmentMerchant Fulfillment
Purchases shipping and returns a shipping label
Deprecated
Creates a shipment for an order, purchases a shipping label from the selected carrier, and returns the label for printing.
Authorization
walletAuth AuthorizationBearer <token>
In: header
Request Body
application/json
shipmentRequestDetails*
shippingServiceId*string
shippingServiceOfferId?string
labelFormat?string
Value in
- "PDF"
- "PNG"
- "ZPL"
- "ZPL300"
- "ShippingServiceDefault"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/mfn/v4/shipments" \ -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": 0, "width": 0, "height": 0, "unit": "inches" }, "weight": { "value": 0, "unit": "oz" }, "shipDate": "2019-08-24T14:15:22Z", "shippingServiceOptions": {} }, "shippingServiceId": "string" }'{ "shipment": { "shipmentId": "string", "orderId": "string", "sellerOrderId": "string", "itemList": [ { "orderItemId": "string", "quantity": 1 } ], "shipFromAddress": { "name": "string", "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "city": "string", "county": "string", "district": "string", "stateOrRegion": "string", "municipality": "string", "postalCode": "string", "countryCode": "US", "phone": "string", "isCommercialAddress": true }, "shipToAddress": { "name": "string", "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "city": "string", "county": "string", "district": "string", "stateOrRegion": "string", "municipality": "string", "postalCode": "string", "countryCode": "US", "phone": "string", "isCommercialAddress": true }, "packageDimensions": { "length": 0, "width": 0, "height": 0, "unit": "inches" }, "weight": { "value": 0, "unit": "oz" }, "insurance": { "amount": "string", "currencyCode": "USD" }, "shippingService": { "shippingServiceId": "string", "carrierName": "UPS", "shippingServiceName": "string", "shippingServiceOfferId": "string", "shipDate": "2019-08-24T14:15:22Z", "earliestEstimatedDeliveryDate": "2019-08-24T14:15:22Z", "latestEstimatedDeliveryDate": "2019-08-24T14:15:22Z", "rate": { "amount": "string", "currencyCode": "USD" }, "shippingServiceOptions": { "deliveryExperience": "DeliveryConfirmationWithAdultSignature", "carrierWillPickUp": true, "carrierWillPickUpOption": "CarrierContact", "declaredValue": { "amount": "string", "currencyCode": "USD" } } }, "label": { "customTextForLabel": "string", "dimensions": { "length": 0, "width": 0, "unit": "inches" }, "fileContents": { "contents": "string", "fileType": "application/pdf", "checksum": "string" }, "labelFormat": "PDF", "standardIdForLabel": "WalmartOrderId" }, "shipmentStatus": "PURCHASED", "createdDate": "2019-08-24T14:15:22Z", "lastUpdatedDate": "2019-08-24T14:15:22Z" }}Returns a list of shipping service offers POST
Returns available carriers and rates for a shipment based on package dimensions, weight, and destination address.
Returns the shipping label for an existing shipment GET
Returns the purchased shipping label for a shipment in the requested file format for printing.