Create Shipment

Creates a merchant fulfillment shipment in Amazon Seller.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

string

object

string

number

boolean

string

Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.

object

string

object

string

number

boolean

When true, include a packing slip with the label.

boolean

string

array

object

string

The label format. Allowed: `PDF`, `PNG`, `ZPL203`, `ZPL300`, `ShippingServiceDefault` Format,Description PDF,Portable Document Format (pdf). PNG,Portable Network Graphics (png) format. ZPL203,"Zebra Programming Language (zpl) format, 203 dots per inch resolution." ZPL300,"Zebra Programming Language (zpl) format, 300 dots per inch resolution." ShippingServiceDefault,The default provided by the shipping service. Sources https://gitee.com/llzunmin/spapi

object

number

object

date

string

object

string

number

string

date

object

array

string

object

string

The type of standard identifier to print on the label. Allowed: `AmazonOrderId` Value Description AmazonOrderId Amazon-defined order identifier in 3-7-7 format is the StandardIdForLabel.

stringrequired

string

number

object

boolean

object

number

string

date

object

number

object

string

object

array

curl --request POST \ --url "https://connect.mindcloud.co/v1/universal/amazonSeller/0.0.80/actions/create-shipment" \ --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "connectionId": "$CONNECTION_ID", "shipmentRequestDetails.itemList[].itemLevelSellerInputsList[].additionalSellerInput.valueAsAddress.stateOrProvinceCode": "" }'

{ "success": true, "data": [ { "amazonOrderId": "string", "createdDate": "string", "insurance": { "amount": 1, "currencyCode": "string" }, "itemList[]": { "dangerousGoodsDetails": { "packingGroup": "string", "packingInstruction": "string", "transportationRegulatoryClass": "string", "unitedNationsRegulatoryId": "string" }, "isHazmat": true, "itemDescription": "string", "itemLevelSellerInputsList[]": { "additionalInputFieldName": "string", "additionalSellerInput": { "dataType": "string", "valueAsAddress": { "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "city": "string", "countryCode": "string", "districtOrCounty": "string", "email": "[email protected]", "name": "Ava Chen", "phone": "string", "postalCode": "string", "stateOrProvinceCode": "string" }, "valueAsBoolean": true, "valueAsCurrency": { "amount": 1, "currencyCode": "string" }, "valueAsDimension": { "unit": "string", "value": 1 }, "valueAsInteger": 1, "valueAsString": "string", "valueAsTimestamp": "string", "valueAsWeight": { "unit": "string", "value": 1 } } }, "itemWeight": { "unit": "string", "value": 1 }, "liquidVolume": { "unit": "string", "value": 1 }, "orderItemId": "string", "quantity": 1, "transparencyCodeList[]": "string" }, "label": { "customTextForLabel": "string", "dimensions": { "length": 1, "unit": "string", "width": 1 }, "fileContents": { "checksum": "string", "contents": "string", "fileType": "string" }, "labelFormat": "string", "standardIdForLabel": "string" }, "lastUpdatedDate": "string", "packageDimensions": { "height": 1, "length": 1, "predefinedPackageDimensions": "string", "unit": "string", "width": 1 }, "sellerOrderId": "string", "shipFromAddress": { "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "city": "string", "countryCode": "string", "districtOrCounty": "string", "email": "[email protected]", "name": "Ava Chen", "phone": "string", "postalCode": "string", "stateOrProvinceCode": "string" }, "shipmentId": "string", "shippingService": { "adjustmentItemList[]": { "rateItemCharge": { "amount": 1, "currencyCode": "string" }, "rateItemID": "string", "rateItemNameLocalization": "string", "rateItemType": "string" }, "availableFormatOptionsForLabel[]": { "includePackingSlipWithLabel": true, "labelFormat": "string" }, "availableLabelFormats[]": "string", "availableShippingServiceOptions": { "availableCarrierWillPickUpOptions[]": { "carrierWillPickUpOption": "string", "charge": { "amount": 1, "currencyCode": "string" } }, "availableDeliveryExperienceOptions[]": { "charge": { "amount": 1, "currencyCode": "string" }, "deliveryExperienceOption": "string" } }, "benefits": { "excludedBenefits[]": { "benefit": "string", "reasonCodes[]": "string" }, "includedBenefits[]": "string" }, "carrierName": "string", "earliestEstimatedDeliveryDate": "string", "latestEstimatedDeliveryDate": "string", "rate": { "amount": 1, "currencyCode": "string" }, "rateWithAdjustments": { "amount": 1, "currencyCode": "string" }, "requiresAdditionalSellerInputs": true, "shipDate": "string", "shippingServiceId": "string", "shippingServiceName": "string", "shippingServiceOfferId": "string", "shippingServiceOptions": { "carrierWillPickUp": true, "carrierWillPickUpOption": "string", "declaredValue": { "amount": 1, "currencyCode": "string" }, "deliveryExperience": "string", "labelFormat": "string" } }, "shipToAddress": { "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "city": "string", "countryCode": "string", "districtOrCounty": "string", "email": "[email protected]", "name": "Ava Chen", "phone": "string", "postalCode": "string", "stateOrProvinceCode": "string" }, "status": "string", "trackingId": "string", "weight": { "unit": "string", "value": 1 } } ], "meta": {} }

Query

Body

Every app you connect,one REST pattern