TDV Adapter for Amazon Marketplace

Build 22.0.8538

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 CreatedDate column. The date range to search must not be more than 7 days.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

Some example queries:

SELECT * FROM VendorShippingLabels

SELECT * FROM VendorShippingLabels WHERE PurchaseOrderNumber = '12345'

SELECT * FROM VendorShippingLabels WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'

Insert

When inserting, you can also use temp tables in order to insert fields for aggregate objects, as shown in the example below:
INSERT INTO Items#temp (ItemSequenceNumber, BuyerProductIdentifier, VendorProductIdentifier, Amount, UnitOfMeasure) 
                VALUES (                 1,              'item_id',               'prod_id',     10,        'unit');

INSERT INTO Container#temp (ContainerType, ContainerIdentifier, TrackingNumber,  PackedItems) 
                    VALUES (     'carton',      'container_id',       'string', 'Items#temp');

INSERT INTO Address1#temp(  Name,     AddressLine1,          City,           County, CountryCode)
                  VALUES ('Name', 'Fayettville NC', 'Fayettville', 'North Carolina',        'NC');

INSERT INTO TaxTest#temp (RegistrationType, RegistrationNumber, RegistrationMessages, RegistrationAddress) 
                  VALUES (           'VAT',           'string',             'string',    'Address1#temp');

INSERT INTO VendorShippingLabels (PurchaseOrderNumber, SellingPartyPartyId,  SellingPartyTaxRegistrationDetails, ShipFromPartyPartyId,       Containers)
                          VALUES ('1234567890',                    '11111',                      'TaxTest#temp',              '22222', 'Container#temp');

In order to get the Transaction ID returned from the API for the insert statement, you can issue a select statement from the LastResultInfo temp table, as shown below:

SELECT * FROM LastResultInfo#temp 

Container temporary table schema info:

Column NameTypeRequiredDescription
ContainerType String True The type of container.
ContainerIdentifier String True The container identifier.
TrackingNumber String False The tracking number.
ContainerSequenceNumber Integer False An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
ManifestId String False The manifest identifier.
ManifestDate String False The date of the manifest.
ShipMethod String False The shipment method.
ScacCode String False SCAC code required for NA VOC vendors only.
Carrier String False Carrier required for EU VOC vendors only.
Length String False Physical dimensional measurements of a container.
Width String False Physical dimensional measurements of a container.
Height String False Physical dimensional measurements of a container.
DimensionUnit String False Physical dimensional measurements of a container.
Value String False The weight.
WeightUnit String False The weight.
PackedItems Aggregate True A list of packed items. See: PackedItems table schema.

PackedItems temporary table schema info:

Column NameTypeRequiredDescription
ItemSequenceNumber Integer True Item Sequence Number for the item. This must be the same value as sent in the order for a given item.
BuyerProductIdentifier String False Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
VendorProductIdentifier String False The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number.
Amount Decimal True Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level.
UnitOfMeasure String True Unit of measure for the shipped quantity.

TaxRegistrationDetails temporary table schema info:

Column NameTypeRequiredDescription
RegistrationType String True Tax registration type for the entity. Allowed Values: VAT, GST.
RegistrationNumber String True Tax registration number for the party. For example, VAT ID.
RegistrationMessages String False Tax registration message that can be used for additional tax related details
RegistrationAddress Aggregate False Address of the party. See: AddressDetails table schema.

Address temporary table schema info:

Column NameType RequiredDescription
Name String True The name of the person, business or institution at that address.
AddressLine1 String True First line of street address.
AddressLine2 String False Additional address information, if required.
AddressLine3 String False Additional address information, if required.
City String False The city where the person, business or institution is located.
County String False The county where person, business or institution is located.
District String False The district where person, business or institution is located.
StateOrRegion String False The state or region where person, business or institution is located.
PostalOrZipCode String False The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
CountryCode String True The two digit country code. In ISO 3166-1 alpha-2 format.
Phone String False The phone number of the person, business or institution located at that address.

Columns

Name Type ReadOnly References Description
PurchaseOrderNumber [KEY] String False

This field will contain the Purchase Order Number for this order.

LabelFormat String True

Format of the label.

The allowed values are PNG, ZPL.

LabelData String True

Provides the details of the packages in this shipment.

SellingPartyPartyId String False

Assigned Identification for the party.

SellingPartyAddressLine1 String False

First line of the address.

SellingPartyAddressLine2 String False

Additional street address information, if required.

SellingPartyAddressLine3 String False

Additional street address information, if required.

SellingPartyAddressCity String False

The city where the person, business or institution is located.

SellingPartyAddressCountryCode String False

The two digit country code in ISO 3166-1 alpha-2 format.

SellingPartyAddressCounty String False

The county where person, business or institution is located.

SellingPartyAddressDistrict String False

The district where person, business or institution is located.

SellingPartyAddressName String False

The name of the person, business or institution at that address.

SellingPartyAddressPhone String False

The phone number of the person, business or institution located at that address.

SellingPartyAddressPostalCode String False

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

SellingPartyAddressStateOrRegion String False

The state or region where person, business or institution is located.

SellingPartyTaxRegistrationDetails String False

Tax registration details of the entity. See: TaxRegistrationDetails temporary table schema.

ShipFromPartyPartyId String False

Assigned Identification for the party.

ShipFromPartyAddressLine1 String False

First line of the address.

ShipFromPartyAddressLine2 String False

Additional street address information, if required.

ShipFromPartyAddressLine3 String False

Additional street address information, if required.

ShipFromPartyAddressCity String False

The city where the person, business or institution is located.

ShipFromPartyAddressCountryCode String False

The two digit country code in ISO 3166-1 alpha-2 format.

ShipFromPartyAddressCounty String False

The county where person, business or institution is located.

ShipFromPartyAddressDistrict String False

The district where person, business or institution is located.

ShipFromPartyAddressName String False

The name of the person, business or institution at that address.

ShipFromPartyAddressPhone String False

The phone number of the person, business or institution located at that address.

ShipFromPartyAddressPostalCode String False

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

ShipFromPartyAddressStateOrRegion String False

The state or region where person, business or institution is located.

ShipFromPartyTaxRegistrationDetails String False

Tax registration details of the entity. See: TaxRegistrationDetails temporary table schema.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CreatedDate String

Filters for created date. If left empty the default specified range is from 6 days earlier to today.

Containers String

A list of the packages in this shipment. Only used for Insert statements. See: Container temporary table schema.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8538