XML Mapping
You must connect an XML Map connector to the Amazon Marketplace connector to map the required input parameters, as shown in the image below.
Input Parameters
The following table lists the input parameters that you can map with the XML Map connector interface.| Name | Data Type | Required? | Description |
|---|---|---|---|
| Shipment Identifier | String | True | The unique shipment ID. |
| ShipmentConfirmation Type | String | True | The shipment confirmation type. This parameter indicates whether this shipment confirmation is the initial confirmation or whether it is intended to replace a shipment confirmation that is already posted. The allowed values are Original and Replace. |
| ShipmentType | String | False | The type of shipment. Allowed values are TruckLoad, LessThanTruckLoad, and SmallParcel. |
| ShipmentStructure | String | False | The shipment hierarchical structure. Allowed values are PalletizedAssortmentCase, LooseAssortmentCase, PalletOfItems, PalletizedStandardCase, LooseStandardCase, MasterPallet, and MasterCase. |
| TransportationDetails CarrierScac | String | False | The code that identifies the carrier for the shipment. |
| TransportationDetails CarrierShipment ReferenceNumber | String | False | A unique number that is assigned by the carrier. This field is also known as PRO number. |
| TransportationDetails TransportationMode | String | False | The mode of transportation for this shipment. Allowed values are Road, Air, and Ocean. |
| TransportationDetails BillOfLadingNumber | String | False | The Bill Of Lading (BOL) number. This number is the unique number that is assigned by the vendor. |
| AmazonReferenceNumber | String | False | The Amazon Reference Number. This number is a unique identifier that is generated by Amazon for all Collect/WePay shipments. |
| ShipmentConfirmation Date | Datetime | True | The date on which the shipment confirmation is submitted. |
| ShippedDate | Datetime | False | The date and time of the departure of the shipment from the vendor’s location. |
| EstimatedDeliveryDate | Datetime | False | The date and time by which the shipment is expected to reach the buyer’s warehouse. |
| SellingPartyId | String | True | The assigned identification for the selling party. |
| SellingPartyAddress | Aggregate | False | An aggregate representation of the selling party’s address. |
| SellingPartyAddress/ Name | String | True | The seller’s name. |
| SellingPartyAddress/ AddressLine1 | String | True | The first line of the selling party’s address. |
| SellingPartyAddress/ AddressLine2 | String | False | Additional address information (if required). |
| SellingPartyAddress/ AddressLine3 | String | False | Additional address information (if required). |
| SellingPartyAddress/ City | String | False | The city where the selling party is located. |
| SellingPartyAddress/ County | String | False | The county where the selling party is located. |
| SellingPartyAddress/ District | String | False | The district where the selling party is located. |
| SellingPartyAddress/ StateOrRegion | String | False | The state or region where the selling party is located. |
| SellingPartyAddress/ PostalCode | String | False | The postal code for the address. This code consists of a series of letters, digits, or both. |
| SellingPartyAddress/ CountryCode | String | False | The two-digit country code in ISO 3166-1 alpha-2 format. |
| SellingPartyAddress/ Phone | String | False | The phone number for the selling party that is located at that address. |
| SellingParty TaxRegistrationType | String | False | The tax registration type for the entity. Allowed values are VAT (the value-added tax) and GST (the goods-and-services tax). |
| SellingParty TaxRegistrationNumber | String | False | The tax registration number for the entity (for example, the VAT Id). |
| ShipFromPartyId | String | True | The assigned identification for the ship-from party. |
| ShipFromPartyAddress | Aggregate | False | The identification of the shipper, by address. |
| ShipFromPartyAddress/ Name | String | True | The shipper’s name. |
| ShipFromPartyAddress/ AddressLine1 | String | True | The first line of the shipper’s address. |
| ShipFromPartyAddress/ AddressLine2 | String | False | Additional address information (if required). |
| ShipFromPartyAddress/ AddressLine3 | String | False | Additional address information (if required). |
| ShipFromPartyAddress/ City | String | False | The city where the shipper is located. |
| ShipFromPartyAddress/ County | String | False | The county where the shipper is located. |
| ShipFromPartyAddress/ District | String | False | The district where the shipper is located. |
| ShipFromPartyAddress/ StateOrRegion | String | False | The state or region where the shipper party is located. |
| ShipFromPartyAddress/ PostalCode | String | False | The postal code for the shipper’s address. This code consists of a series of letters, digits, or both. |
| ShipFromPartyAddress/ CountryCode | String | False | The two-digit country code in ISO 3166-1 alpha-2 format. |
| ShipFromPartyAddress/ Phone | String | False | The shipper’s phone number. |
| ShipFromPartyAddress TaxRegistrationType | String | False | The tax registration type for the entity. Allowed values are VAT (the value-added tax) and GST (the goods-and-services tax). |
| ShipFromPartyAddress TaxRegistrationNumber | String | False | The tax registration number for the entity (for example, the VAT Id). |
| ShipToPartyId | String | True | The assigned identification for the ship-to party. |
| ShipToPartyAddress | Aggregate | False | The identification of the ship-to party, by address. |
| ShipToPartyAddress/ Name | String | True | The ship-to party’s name. |
| ShipToPartyAddress/ AddressLine1 | String | True | The first line of the ship-to party’s address. |
| ShipToPartyAddress/ AddressLine2 | String | False | Additional address information (if required). |
| ShipToPartyAddress/ AddressLine3 | String | False | Additional address information (if required). |
| ShipToPartyAddress/ City | String | False | The city where the ship-to party is located. |
| ShipToPartyAddress/ County | String | False | The county where the ship-to party is located. |
| ShipToPartyAddress/ District | String | False | The district where the ship-to party is located. |
| ShipToPartyAddress/ StateOrRegion | String | False | The state or region where the ship-to party is located. |
| ShipToPartyAddress/ PostalCode | String | False | The postal code for the ship-to address. This code consists of a series of letters, digits, or both. |
| ShipToPartyAddress/ CountryCode | String | False | The two-digit country code in ISO 3166-1 alpha-2 format. |
| ShipToPartyAddress/ Phone | String | False | The phone number for the ship-to party that is located at that address. |
| ShipToParty TaxRegistrationType | String | False | The tax registration type for the ship-to party. Allowed values are VAT (the value-added tax) and GST (the goods-and-services tax). |
| ShipTo TaxRegistrationNumber | String | False | The tax registration number for the ship-to party (for example, the VAT Id). |
| ShipmentMeasurements | String | False | The JSON aggregate representation of the shipment measurement details. |
| ImportDetails | String | False | The JSON aggregate representation of the import details. |
| ShippedItems | Aggregate | True | An aggregate representation of the items in this shipment. |
| ShippedItems/ ItemSequenceNumber | String | True | The line-item sequence number for the item. |
| ShippedItems/ AmazonProductIdentifier | String | False | The Amazon Standard Identification Number (ASIN) of an item. |
| ShippedItems/ VendorProductIdentifier | String | False | The vendor-selected product identification of the item. |
| ShippedItems/ ShippedQuantityAmount | Integer | True | The shipped quantity. This value should not be zero. |
| ShippedItems/ ShippedQuantityUnit | String | True | The unit of measure for the shipped quantity. |
| ShippedItems/ ShippedQuantityUnitSize | Integer | False | The unit size for the shipped quantity. |
| ShippedItems/ PurchaseOrderNumber | String | False | The Amazon purchase order (PO) number for the shipped item that is being confirmed. The PO number should be formatted as an eight-character, alphanumeric code. |
| ShippedItems/ LotNumber | String | False | The lot number of the shipped quantity. |
| ShippedItems/ ExpiryManufacturerDate | Datetime | False | The production, packaging, or assembly date that is determined by the manufacturer. This date’s meaning is determined based on the trade-item context. |
| ShippedItems/ ExpiryDate | Datetime | False | The date that determines the limit of consumption or use of a product. This date’s meaning is determined based on the trade item context. |
| ShippedItems/ ExpiryAfterDuration Unit | Datetime | False | The unit for the duration after the manufacturing date during which the product is valid for consumption. |
| ShippedItems/ ExpiryAfterDuration Value | Integer | False | The value for the duration in terms of the duration unit. |
| ShippedItems/ MaximumRetailPrice CurrencyCode | String | False | The three-digit currency code, in ISO 4217 format, for the maximum retail prices. |
| ShippedItems/ MaximumRetailPrice Amount | String | False | The maximum retail price for the shipped items as a decimal number with no loss of precision. |
| ShippedItems/ HandlingCode | String | False | The code that identifies the instructions about how the specified item, carton, or pallet should be handled. |
| Cartons | Aggregate | True | An aggregate representation of the cartons in this shipment. |
| Cartons/ CartonIdentifiers | Aggregate | False | A list of carton identifiers. |
| Cartons/ CartonIdentifiers/ Container Identification Type | String | True | The container identification type. |
| Cartons/ CartonIdentifiers/ Container Identification Number | String | True | The container identification number that adheres to the definition of the container identification type. |
| Cartons/ CartonSequenceNumber | String | True | The sequence number for the carton. The first carton is numbered 001, the second 002, and so on. This number is used as a reference to refer to the carton from the pallet level. |
| Cartons/ DimensionsLength | String | False | The length of the container. |
| Cartons/ DimensionsWidth | String | False | The width of the container. |
| Cartons/ DimensionsHeight | String | False | The height of the container. |
| Cartons/ WeightValue | String | False | The weight measurement value for the container as a decimal number with no loss of precision. |
| Cartons/ WeightUnit | String | False | The unit of measure for the weight of the container. |
| Cartons/ TrackingNumber | String | False | The tracking number for the container. This number is required for every carton in the small-parcel shipments. |
| Cartons/ CartonsItems | Aggregate | False | A list of carton item details. |
| Cartons/ CartonsItems/ ItemReference | String | True | The reference number for the item. Be sure to provide the item sequence number from the items segment to refer to that item’s details here. |
| Cartons/ CartonsItems/ ShippedQuantityAmount | Integer | True | The number of units that are shipped for a specific item at a shipment level. If the item is present only in certain cartons within the shipment, provide this at the appropriate carton level. |
| Cartons/ CartonsItems/ ShippedQuantityUnit | String | True | The unit of measure for the shipped quantity. |
| Cartons/ CartonsItems/ ShippedQuantityUnitSize | Integer | False | The case size (if product is ordered by the case). Otherwise, the value is 1. |
| Cartons/ CartonsItems/ PurchaseOrderNumber | String | False | The Amazon purchase order (PO) number for the shipment that is being confirmed. If the items in this shipment belong to multiple PO numbers that are in particular carton within the shipment, then provide the PO number at the carton level. The PO numbers should be formatted as an eight-character, alphanumeric code. |
| Cartons/ CartonsItems/ LotNumber | String | False | The batch or lot number for the cartons. This number associates cartons with information that the manufacturer considers relevant for traceability of the cartons to which the element string is applied. The data might refer to the itself or to items within the carton. This field is mandatory for all perishable items. |
| Cartons/ CartonsItems/ ExpiryManufacturerDate | Datetime | False | The production, packaging, or assembly date that is determined by the manufacturer. This date’s meaning is determined based on the trade-item context. |
| Cartons/ CartonsItems/ ExpiryDate | Datetime | False | The date that determines the limit of consumption or use of a product. This date’s meaning is determined based on the trade item context. |
| Cartons/ CartonsItems/ ExpiryAfterDuration Unit | String | False | The unit for the duration after the manufacturing date during which the product is valid for consumption. |
| Cartons/ CartonsItems/ ExpiryAfterDuration Value | Integer | False | The value for the duration in terms of the duration unit. |
| Cartons/ CartonsItems/ MaximumRetailPrice CurrencyCode | String | False | The three-digit currency code, in ISO 4217 format, for the maximum retail prices. |
| Cartons/ CartonsItems/ MaximumRetailPrice Amount | String | False | The maximum retail price for the shipped items as a decimal number with no loss of precision. |
| Cartons/ CartonsItems/ HandlingCode | String | False | A code that identifies the instructions about how the specified carton should be handled. |
| Pallets | Aggregate | False | An aggregate representation of the pallets in this shipment. |
| Pallets/ PalletIdentifiers | Aggregate | True | A list of pallet identifiers. |
| Pallets/ PalletIdentifiers/ Container Identication Type | String | True | The container identification type. Allowed values are SSCC, AMZNCC, GTIN, BPS, and CID. |
| Pallets/ PalletIdentifiers/ Container Identification Number | String | True | The container identification number that adheres to the definition of the container identification type. |
| Pallets/ Tier | Integer | False | The number of layers per pallet. |
| Pallets/ Block | Integer | False | The number of cartons per layer on the pallet. |
| Pallets/ DimensionsLength | String | False | The length of the pallet. |
| Pallets/ DimensionsWidth | String | False | The width of the pallet. |
| Pallets/ DimensionsHeight | String | False | The height of the pallet. |
| Pallets/ DimensionsUnit | String | False | The unit of measure for the dimensions of the pallet. |
| Pallets/ WeightValue | String | False | The weight measurement value for pallet as a decimal number with no loss of precision. |
| Pallets/ WeightUnit | String | False | The unit of measure for the weight of the pallet. |
| Pallets/ CartonsCount | Integer | False | The number of cartons that are present in the shipment. Provide the carton count only for unpalletized shipments. |
| Pallets/ CartonReferenceNumbers | String | False | An array of reference numbers for the cartons that are part of this pallet and shipment. Provide the carton sequence number from the cartons segment to refer to that carton’s details here. |
| Pallets/ PalletsItems | Aggregate | False | A list of pallet item details. |
| Pallets/ PalletsItems/ ItemReference | String | True | The reference number for the item. Provide the item sequence number from the items segment to refer to that item’s details here. |
| Pallets/ PalletsItems/ ShippedQuantityAmount | Integer | True | The number of units that are shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, provide this at the appropriate carton or pallet level. |
| Pallets/ PalletsItems/ ShippedQuantityUnit | String | True | The unit of measure for the shipped quantity. |
| Pallets/ PalletsItems/ ShippedQuantityUnitSize | Integer | False | The case size (if product is ordered by the case). Otherwise, the value is 1. |
| Pallets/ PalletsItems/ PurchaseOrderNumber | String | False | The Amazon purchase order (PO) number for the shipment that is being confirmed. If the items in this shipment belong to multiple PO numbers that are in particular pallet within the shipment, then provide the PO number at the pallet level. The PO numbers should be formatted as an eight-character, alphanumeric code. |
| Pallets/ PalletsItems/ LotNumber | String | False | The batch or lot number for the pallet. This number associates a pallet with information that the manufacturer considers relevant for traceability of the pallet to which the element string is applied. The data might refer to the pallet itself or to items within the pallet. This field is mandatory for all perishable items. |
| Pallets/ PalletsItems/ ExpiryManufacturerDate | Datetime | False | The production, packaging, or assembly date that is determined by the manufacturer. This date’s meaning is determined based on the trade-item context. |
| Pallets/ PalletsItems/ ExpiryDate | Datetime | False | The date that determines the limit of consumption or use of a product. This date’s meaning is determined based on the trade item context. |
| Pallets/ PalletsItems/ ExpiryAfterDuration Unit | String | False | The unit for the duration after the manufacturing date during which the product is valid for consumption. |
| Pallets/ PalletsItems/ ExpiryAfterDuration Value | Integer | False | The value for the duration in terms of the duration unit. |
| Pallets/ PalletsItems/ MaximumRetailPrice CurrencyCode | String | False | The three-digit currency code, in ISO 4217 format, for the maximum retail prices. |
| Pallets/ PalletsItems/ MaximumRetailPrice Amount | String | False | The maximum retail price for the shipped items as a decimal number with no loss of precision. |
| Pallets/ PalletsItems/ HandlingCode | String | False | A code that identifies the instructions about how the specified pallet should be handled. |