Salesforce Docs Portal

Amazon Marketplace Connector Objects (VendorCentral Schema)

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name Description
CatalogItems The Catalog Items table helps you retrieve item details for items in the catalog.
CatalogItemsClassifications The Catalog Items Classifications table helps you retrieve classification details for items in the catalog.
Destinations Returns information about all destinations.
ListingsItems Returns details about a listings item for a selling partner.
ListingsItemsAttributes Returns details about a listings item attributes for a selling partner.
ListingsItemsIssues Returns details about a listings item issues for a selling partner.
ListingsItemsOffers Returns details about a listings item offers for a selling partner.
ListingsItemsSummaries Returns details about a listings item summaries for a selling partner.
ReportList Returns report details for the reports that match the filters that you specify.
ReportTypes Returns report details for the reports that match the filters that you specify.
Subscriptions Returns information about subscriptions of the specified notification type.
VendorCustomerInvoices This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of customer invoices created during a time frame that you specify. The date range to search must be no more than 7 days.
VendorOrderItems Returns a purchase order based on the purchaseOrderNumber value that you specify.
VendorOrders The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
VendorOrderStatus Returns purchase order statuses based on the filters that you specify.
VendorPackingSlips This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.
VendorShippingLabels This table is part of Vendor Direct Fulfillment Shipping API. Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. The date range to search must not be more than 7 days.

CatalogItems

Name Type ReadOnly References FilterOnly Description
MarketplaceASIN [KEY] String False No The Marketplace ASIN.
AdultProduct Boolean False No Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature.
Autographed Boolean False No Identifies an Amazon catalog item is autographed by a player or celebrity.
Brand String False No Name of the brand associated with an Amazon catalog item.
BrowseClassificationClassificationId String False No Classification Id (browse node) associated with an Amazon catalog item.
BrowseClassificationDisplayName String False No Classification Name (browse node) associated with an Amazon catalog item.
Color String False No Name of the color associated with an Amazon catalog item.
ContributorsRole String False No Role of an individual contributor in the creation of an item, such as author or actor.
ContributorsName String False No Name of the contributor.
ItemClassification String False No Classification type associated with the Amazon catalog item.
ItemName String False No Name, or title, associated with an Amazon catalog item.
Manufacturer String False No Name of the manufacturer associated with an Amazon catalog item.
Memorabilia Boolean False No Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment.
ModelNumber String False No Model number associated with an Amazon catalog item.
PackageQuantity Integer False No Quantity of an Amazon catalog item in one package.
PartNumber String False No Part number associated with an Amazon catalog item.
ReleaseDate String False No First date on which an Amazon catalog item is shippable to customers.
Size String False No Name of the size associated with an Amazon catalog item.
Style String False No Name of the style associated with an Amazon catalog item.
TradeInEligible Boolean False No Identifies an Amazon catalog item is eligible for trade-in.
WebsiteDisplayGroup String False No Identifier of the website display group associated with an Amazon catalog item.
WebsiteDisplayGroupName String False No Display name of the website display group associated with an Amazon catalog item.
Attributes String False No A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions.
Classifications String False No A JSON array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace.
Dimensions String False No A JSON object of the dimensions for an item in the Amazon catalog.
Identifiers String False No A JSON object of the identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
Images String False No A JSON object of the images for an item in the Amazon catalog.
ProductTypes String False No A JSON object of the product types associated with the Amazon catalog item.
Relationships String False No A JSON object of the relationship details of an Amazon catalog item (for example, variations).
SalesRankings String False No A JSON object of the sales ranks of an Amazon catalog item.
VendorDetails String False No A JSON object of the vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.
ASIN String False No Amazon Standard Identification Number that identifies a product.
EAN String False No A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes.
GTIN String False No A Global Trade Item Number that uniquely identifies a product.
ISBN String False No The unique commercial book identifier used to identify books internationally.
JAN String False No A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
MINSAN String False No A Minsan Code that uniquely identifies an item.
SellerSKU String False No Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId
UPC String False No A 12-digit bar code used for retail packaging.
IncludedData String False No A comma-delimited list of item details to request. If none are specified, will default to returning summaries data. Values: attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails.
Locale String False No Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
SellerId String False No A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU.
PageSize String False No Number of results to be returned per page.
Query String False No Keyword(s) to use to search for items in the catalog.
BrandNames String False No A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
ClassificationIds String False No A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
KeywordsLocale String False No The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.
MarketplaceId String False No Specifies the marketplace for which items are returned.

Return to Top

CatalogItemsClassifications

Name Type ReadOnly References FilterOnly Description
ClassificationId [KEY] String True No Identifier of the classification (browse node identifier).
MarketplaceASIN [KEY] String False No Amazon Standard Identification Number that identifies a product.
DisplayName String True No Display name for the classification (browse node).
ParentClassificationId String True No Parent classification (browse node) ID of the current classification.
MarketplaceId String False No Specifies the marketplace for which items are returned.
ShowParentClassifications Boolean True No Specifies whether to list all browse nodes for the item(s) or just the top-level browse node. By default, only the top-level browse nodes are listed.
EAN String False No A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes.
GTIN String False No A Global Trade Item Number that uniquely identifies a product.
ISBN String False No The unique commercial book identifier used to identify books internationally.
JAN String False No A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
MINSAN String False No A Minsan Code that uniquely identifies an item.
SellerSKU String False No Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId
UPC String False No A 12-digit bar code used for retail packaging.
Locale String False No Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
SellerId String False No A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU.
Query String False No Keyword(s) to use to search for items in the catalog.
BrandNames String False No A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
ItemClassifications String False No A comma-separated list of classification IDs for filtering keyword searches. The results may vary, as the classification could refer to either the item's classification or its parent classification. Note: Cannot be used with identifiers.
KeywordsLocale String False No The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.

Return to Top

Destinations

Name Type ReadOnly References FilterOnly Description
DestinationId [KEY] String False No The destination identifier generated when you created the destination.
Name String False No The developer-defined name for this destination.
ResourceSqsArn String False No The Amazon Resource Name (ARN) associated with the SQS queue (Amazon Simple Queue Service queue destination).
ResourceEventBridgeName String False No The name of the partner event source associated with the destination (Amazon EventBridge destination).
ResourceEventBridgeRegion String False No The AWS region in which you will be receiving the notifications (Amazon EventBridge destination).
ResourceEventBridgeAccountId String False No The identifier for the AWS account that is responsible for charges related to receiving notifications (Amazon EventBridge destination).

Return to Top

ListingsItems

Name Type ReadOnly References FilterOnly Description
SKU [KEY] String False No A selling partner provided identifier for an Amazon listing.
FulfillmentAvailability String False No Fulfillment availability for the listings item.
Procurements String False No The vendor procurement information for the listings item.
ProcurementCostCurrency String False No The price (ISO4217 currency code) that you want Amazon to pay you for this product.
ProcurementCostAmount String False No The price (numeric value) that you want Amazon to pay you for this product.
Attributes String False No This field is required for INSERT statements. Aggregate field containing structured 'AttributeName' and 'AttributeValue' fields.
SellerId [KEY] String False No A selling partner identifier, such as a merchant account or vendor code.
Requirements String False No This field can be specified for INSERT statements.
ProductType String False No This field is required for INSERT statements.

Return to Top

ListingsItemsAttributes

Name Type ReadOnly References FilterOnly Description
SKU [KEY] String True No A selling partner provided identifier for an Amazon listing.
AttributeName [KEY] String False No The attribute name for the listings item.
AttributeValue String False No The attribute value for the listings item.
ProductType String False No The Amazon product type of the listings item. Required for Updating an attribute.
SellerId [KEY] String True No A selling partner identifier, such as a merchant account or vendor code.
AttributePath String True No The attribute path for the listings item.
AttributeGroup String True No The attribute group for the listings item.

Return to Top

ListingsItemsIssues

Name Type ReadOnly References FilterOnly Description
SKU String True No A selling partner provided identifier for an Amazon listing.
Code String False No An issue code that identifies the type of issue.
Message String False No A message that describes the issue.
Severity String False No The severity of the issue.
SellerId String False Yes A selling partner identifier, such as a merchant account or vendor code.

Return to Top

ListingsItemsOffers

Name Type ReadOnly References FilterOnly Description
SKU String True No A selling partner provided identifier for an Amazon listing
MarketplaceId String False No A marketplace identifier. Identifies the Amazon marketplace for the listings item.
OfferType String False No Type of offer for the listings item.
PriceAmount String False No Purchase price amount of the listings item.
PriceCurrency String False No Purchase price currency of the listings item.
Points String False No The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP).
SellerId String False Yes A selling partner identifier, such as a merchant account or vendor code.

Return to Top

ListingsItemsSummaries

Name Type ReadOnly References FilterOnly Description
SKU String True No A selling partner provided identifier for an Amazon listing.
Asin String False No Amazon Standard Identification Number (ASIN) of the listings item.
ConditionType String False No Identifies the condition of the listings item.
CreatedDate Datetime False No Date the listings item was created, in ISO 8601 format.
ItemName String False No Name, or title, associated with an Amazon catalog item.
LastUpdatedDate Datetime False No Date the listings item was last updated, in ISO 8601 format.
MainImageLink String False No Link, or URL, for the main image.
MainImageHeight Integer False No Height of the main image in pixels.
MainImageWidth Integer False No Width of the main image in pixels.
MarketplaceId String False No A marketplace identifier. Identifies the Amazon marketplace for the listings item.
ProductType String False No The Amazon product type of the listings item.
Status String False No Statuses that apply to the listings item.
SellerId String False Yes A selling partner identifier, such as a merchant account or vendor code.

Return to Top

ReportList

Name Type ReadOnly References FilterOnly Description
ReportId [KEY] String True No Report Id.
ReportType String True No The type of the Report. ReportType is not required when UseSandbox=True.
ReportDocumentId String True No The identifier for the report document.
CreatedTime Datetime True No The date and time when the report was created. While filtering, CreatedTime value is only accepted till 90 days old.
DataStartTime Datetime True No The start of a date and time range used for selecting the data to report.
DataEndTime Datetime True No The end of a date and time range used for selecting the data to report.
MarketplaceIds String True No A list of marketplace identifiers for the report.
ProcessingStartTime Datetime True No The date and time when the report processing started.
ProcessingEndTime Datetime True No The date and time when the report processing completed.
ProcessingStatus String True No The processing status of the report.

Return to Top

ReportTypes

Name Type ReadOnly References FilterOnly Description
ReportTypeId [KEY] String True No Sequential id of the report type.
ReportTypeValue String True No Enumeration value of the report type.
ReportFormat String True No The download format of the report type
Category String True No Report format category.
Description String True No Report format description.
URL String True No Amazon Selling-Partner API Documentation link of the report type.

Return to Top

Subscriptions

Name Type ReadOnly References FilterOnly Description
SubscriptionId [KEY] String False No The subscription identifier generated when the subscription is created.
NotificationType [KEY] String False No The type of notification.
PayloadVersion String False No The version of the payload object to be used in the notification.
DestinationId String False No The identifier for the destination where notifications will be delivered.
MarketplaceIds String False No A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.
AggregationTimePeriod String False No The supported time period to use to perform marketplace-ASIN level aggregation.
EventFilterType String False No An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter.

Return to Top

VendorCustomerInvoices

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber [KEY] String False No This field will contain the Purchase Order Number for this order.
Content String False No The Base64encoded customer invoice.
CreatedDate String False Yes Filters for created date. If left empty the default specified range is from 6 days earlier to today.

Return to Top

VendorOrderItems

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber [KEY] String False No The purchase order number for this order.
ItemSequenceNumber [KEY] String False No Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
PurchaseOrderState String False No The current state of the purchase order.
SellerPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code.
VendorProductIdentifier String False No The vendor selected product identification of the item.
AmazonProductIdentifier String False No Amazon Standard Identification Number (ASIN) of an item.
OrderedQuantityUnitOfMeasure String False No Unit of measure for the acknowledged quantity.
OrderedQuantityAmount Decimal False No Acknowledged quantity. This value should not be zero.
OrderedQuantityUnitSize Int False No The case size, in the event that we ordered using cases.
ListPriceUnitOfMeasure String False No Unit of measure for the acknowledged quantity.
ListPriceAmount Decimal False No Acknowledged quantity. This value should not be zero.
ListPriceCurrencyCode String False No Three digit currency code in ISO 4217 format. String of length 3.
NetCostUnitOfMeasure String False No Unit of measure for the acknowledged quantity.
NetCostAmount Decimal False No Acknowledged quantity. This value should not be zero.
NetCostCurrencyCode String False No Three digit currency code in ISO 4217 format. String of length 3.
IsBackOrderAllowed Bool False No When true, we will accept backorder confirmations for this item.
PurchaseOrderDate Datetime False No The date the purchase order was placed.
PurchaseOrderChangedDate Datetime False No The date when purchase order was last changed by Amazon after the order was placed.

Return to Top

VendorOrders

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber String True No The purchase order number for this order.
PurchaseOrderState String False No The current state of the purchase order.
DealCode String False No If requested by the recipient, this field will contain a promotional/deal number.
DeliveryWindow String False No This indicates the delivery window. Format is start and end date separated by double hyphen (--)
ShipWindow String False No This indicates the ship window. Format is start and end date separated by double hyphen (--).
Items String False No A list of items in this purchase order.
PaymentMethod String False No Payment method used.
PurchaseOrderDate Datetime False No The date the purchase order was placed.
PurchaseOrderChangedDate Datetime False No The date when purchase order was last changed by Amazon after the order was placed.
PurchaseOrderStateChangedDate Datetime False No The date when current purchase order state was changed.
PurchaseOrderType String False No Type of purchase order.
BillPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code.
BillAddressAddressLine1 String False No First line of the address.
BillAddressAddressLine2 String False No Additional address information, if required.
BillAddressAddressLine3 String False No Additional address information, if required.
BillAddressCity String False No The city where the person, business or institution is located.
BillAddressCountryCode String False No The two digit country code in ISO 3166-1 alpha-2 format.
BillAddressCounty String False No The county where person, business or institution is located.
BillAddressDistrict String False No The district where person, business or institution is located.
BillAddressName String False No The name of the address of the person, business or institution.
BillAddressPhone String False No The phone number of the person, business or institution located at that address.
BillAddressPostalCode String False No The postal code of that address. It contains a series of letters or digits or both.
BillAddressStateOrRegion String False No The state or region where person, business or institution is located.
BillTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
BillTaxRegistrationType String False No Tax registration type for the entity.
ShipPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code.
ShipAddressAddressLine1 String False No First line of the address.
ShipAddressAddressLine2 String False No Additional address information, if required.
ShipAddressAddressLine3 String False No Additional address information, if required.
ShipAddressCity String False No The city where the person, business or institution is located.
ShipAddressCountryCode String False No The two digit country code in ISO 3166-1 alpha-2 format.
ShipAddressCounty String False No The county where person, business or institution is located.
ShipAddressDistrict String False No The district where person, business or institution is located.
ShipAddressName String False No The name of the address of the person, business or institution.
ShipAddressPhone String False No The phone number of the person, business or institution located at that address.
ShipAddressPostalCode String False No The postal code of that address. It contains a series of letters or digits or both.
ShipAddressStateOrRegion String False No The state or region where person, business or institution is located.
ShipTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
ShipTaxRegistrationType String False No Tax registration type for the entity.
BuyerPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code.
BuyerAddressAddressLine1 String False No First line of the address.
BuyerAddressAddressLine2 String False No Additional address information, if required.
BuyerAddressAddressLine3 String False No Additional address information, if required.
BuyerAddressCity String False No The city where the person, business or institution is located.
BuyerAddressCountryCode String False No The two digit country code in ISO 3166-1 alpha-2 format.
BuyerAddressCounty String False No The county where person, business or institution is located.
BuyerAddressDistrict String False No The district where person, business or institution is located.
BuyerAddressName String False No The name of the address of the person, business or institution.
BuyerAddressPhone String False No The phone number of the person, business or institution located at that address.
BuyerAddressPostalCode String False No The postal code of that address. It contains a series of letters or digits or both.
BuyerAddressStateOrRegion String False No The state or region where person, business or institution is located.
BuyerTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
BuyerTaxRegistrationType String False No Tax registration type for the entity.
SellerPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code.
SellerAddressAddressLine1 String False No First line of the address.
SellerAddressAddressLine2 String False No Additional address information, if required.
SellerAddressAddressLine3 String False No Additional address information, if required.
SellerAddressCity String False No The city where the person, business or institution is located.
SellerAddressCountryCode String False No The two digit country code in ISO 3166-1 alpha-2 format.
SellerAddressCounty String False No The county where person, business or institution is located.
SellerAddressDistrict String False No The district where person, business or institution is located.
SellerAddressName String False No The name of the address of the person, business or institution.
SellerAddressPhone String False No The phone number of the person, business or institution located at that address.
SellerAddressPostalCode String False No The postal code of that address. It contains a series of letters or digits or both.
SellerAddressStateOrRegion String False No The state or region where person, business or institution is located.
SellerTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
SellerTaxRegistrationType String False No Tax registration type for the entity.
ImportContainers String False No Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers.
InternationalCommercialTerms String False No Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices.
MethodOfPayment String False No If the recipient requests, contains the shipment method of payment. This is for import PO's only.
PortOfDelivery String False No The port where goods on an import purchase order must be delivered by the vendor.
ShippingInstructions String False No Special instructions regarding the shipment.

Return to Top

VendorOrderStatus

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber [KEY] String False No Provides purchase order status for the specified purchase order number.
ItemSequenceNumber [KEY] String False No Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
PurchaseOrderStatus String False No Buyer has received all of the items in the purchase order.
PurchaseOrderDate String False No The date the purchase order was placed. Must be in ISO-8601 date/time format.
BuyerProductIdentifier String False No Buyer's Standard Identification Number (ASIN) of an item.
CurrencyCode String False No Three digit currency code in ISO 4217 format for the listed price. String of length 3.
Amount String False No Acknowledged quantity for the listed price. This value should not be zero.
VendorProductIdentifier String False No The vendor selected product identification of the item.
OrderedQuantityAmount Decimal False No Acknowledged quantity. This value should not be zero.
OrderedQuantityUnitMeasure String False No Unit of measure for the acknowledged quantity.
OrderedQuantityUnitSize Int False No The case size, in the event that we ordered using cases.
ItemReceiveStatus String False No Receive status of the line item.
ItemReceiveAmount Decimal False No Acknowledged quantity. This value should not be zero.
ItemReceiveUnitMeasure String False No Unit of measure for the acknowledged quantity.
ItemReceiveUnitSize Int False No The case size, in the event that we ordered using cases.
ItemReceiveDate Datetime False No The date when the purchase order was last received. Must be in ISO-8601 date/time format.
ItemConfirmationStatus String False No Confirmation status of line item.
ItemConfirmationAmount Decimal False No Acknowledged quantity. This value should not be zero.
ItemConfirmationUnitMeasure String False No Unit of measure for the acknowledged quantity.
ItemConfirmationUnitSize Int False No The case size, in the event that we ordered using cases.
ItemRejectionAmount Decimal False No Acknowledged quantity. This value should not be zero.
ItemRejectionUnitMeasure String False No Unit of measure for the acknowledged quantity.
ItemRejectionUnitSize Int False No The case size, in the event that we ordered using cases.
SellingPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
SellingPartyTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
SellingPartyTaxRegistrationType String False No Tax registration type for the entity.
SellingPartyPostalCode String False No The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyAddressLine1 String False No First line of the address.
SellingPartyAddressLine2 String False No Additional address information, if required.
SellingPartyAddressLine3 String False No Additional address information, if required.
SellingPartyCountryCode String False No The two digit country code. In ISO 3166-1 alpha-2 format.
SellingPartyCounty String False No The county where person, business or institution is located.
SellingPartyCity String False No The city where the person, business or institution is located.
SellingPartyDistrict String False No The district where person, business or institution is located.
SellingPartyName String False No The name of the person, business or institution at that address.
SellingPartyStateOrRegion String False No The state or region where person, business or institution is located.
SellingPartyPhone String False No The phone number of the person, business or institution located at that address.
ShipToPartyId String False No Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
ShipToPartyTaxRegistrationNumber String False No Tax registration number for the entity. For example, VAT ID.
ShipToPartyTaxRegistrationType String False No Tax registration type for the entity.
ShipToPartyPostalCode String False No The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
ShipToPartyAddressLine1 String False No First line of the address.
ShipToPartyAddressLine2 String False No Additional address information, if required.
ShipToPartyAddressLine3 String False No Additional address information, if required.
ShipToPartyCountryCode String False No The two digit country code. In ISO 3166-1 alpha-2 format.
ShipToPartyCounty String False No The county where person, business or institution is located.
ShipToPartyCity String False No The city where the person, business or institution is located.
ShipToPartyDistrict String False No The district where person, business or institution is located.
ShipToPartyName String False No The name of the person, business or institution at that address.
ShipToPartyStateOrRegion String False No The state or region where person, business or institution is located.
ShipToPartyPhone String False No The phone number of the person, business or institution located at that address.
LastUpdatedDate Datetime False No The date when the purchase order was last updated. Must be in ISO-8601 date/time format.
OrderedQuantityDetails String False No Details of item quantity ordered.
AcknowledgementStatusDetails String False No Details of item quantity ordered.

Return to Top

VendorPackingSlips

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber [KEY] String False No This field will contain the Purchase Order Number for this order.
Content String False No A Base64encoded string of the packing slip PDF.
ContentType String False No The format of the file such as PDF, JPEG etc
CreatedDate String False Yes Filters for created date. If left empty the default specified range is from 6 days earlier to today

Return to Top

VendorShippingLabels

Name Type ReadOnly References FilterOnly Description
PurchaseOrderNumber [KEY] String False No
LabelFormat String True No
LabelData String True No
SellingPartyPartyId String False No
SellingPartyAddressLine1 String False No
SellingPartyAddressLine2 String False No
SellingPartyAddressLine3 String False No
SellingPartyAddressCity String False No
SellingPartyAddressCountryCode String False No
SellingPartyAddressCounty String False No
SellingPartyAddressDistrict String False No
SellingPartyAddressName String False No
SellingPartyAddressPhone String False No
SellingPartyAddressPostalCode String False No
SellingPartyAddressStateOrRegion String False No
SellingPartyTaxRegistrationDetails String False No
ShipFromPartyPartyId String False No
ShipFromPartyAddressLine1 String False No
ShipFromPartyAddressLine2 String False No
ShipFromPartyAddressLine3 String False No
ShipFromPartyAddressCity String False No
ShipFromPartyAddressCountryCode String False No
ShipFromPartyAddressCounty String False No
ShipFromPartyAddressDistrict String False No
ShipFromPartyAddressName String False No
ShipFromPartyAddressPhone String False No
ShipFromPartyAddressPostalCode String False No
ShipFromPartyAddressStateOrRegion String False No
ShipFromPartyTaxRegistrationDetails String False No
CreatedDate String False Yes
Containers String False Yes

Return to Top