CData Python Connector for Amazon Marketplace

Build 25.0.9454

FBMShipments

Returns the merchant fulfilled shipment information for an existing shipment.

Columns

Name Type ReadOnly References Description
ShipmentId [KEY] String False

The Amazon-defined shipment identifier for the shipment to cancel.

OrderItemId [KEY] String False

An Amazon-defined identifier for an individual item in an order.

AmazonOrderId String False

An Amazon-defined order identifier, in 3-7-7 format.

AvailableCarrierWillPickUpOption String False

Indicates whether the carrier will pick up the package, and what fee is charged, if any.

AvailableDeliveryExperienceOption String False

The available delivery confirmation options, and the fee charged, if any.

AvailableLabelFormats String False

The label format.

CarrierName String False

The name of the carrier.

Checksum String False

An MD5 hash to validate the PDF document data, in the form of a Base64 string.

Contents String False

Data for printing labels encoded into a Base64, GZip-compressed string.

CreatedDate Datetime False

Date-time formatted timestamp.

DimensionsLength Decimal False

A label dimension.

DimensionsUnit String False

The unit of length.

DimensionsWidth Decimal False

A label dimension.

EarliestEstimatedDeliveryDate Datetime False

Date-time formatted timestamp.

ExcludedBenefit String False

An object representing an excluded benefit that is excluded for a shipping offer or rate.

FileType String False

The file type for a label.

PackageHeight Decimal False

The package height.

IncludedBenefits String False

A list of included benefits.

InsuranceAmount Decimal False

The currency amount.

InsuranceCurrencyCode String False

Three-digit currency code in ISO 4217 format.

IsHazmat Bool False

When true, the item qualifies as hazardous materials (hazmat). Defaults to false.

ItemDescription String False

The description of the item.

ItemSellerInputsList String False

An additional set of seller inputs required to purchase shipping.

ItemWeightUnit String False

The unit of weight.

ItemWeightValue Decimal False

The weight value.

LabelCustomTextForLabel String False

Custom text to print on the label.

LabelFormatOption String False

The label format details and whether to include a packing slip.

LabelLabelFormat String False

The label format.

LabelStandardIdForLabel String False

The type of standard identifier to print on the label.

LastUpdatedDate Datetime False

Date-time formatted timestamp.

LatestEstimatedDeliveryDate Datetime False

Date-time formatted timestamp.

LiquidVolumeUnit String False

The unit of measurement.

LiquidVolumeValue Decimal False

The measurement value.

PackageLength Decimal False

The package length.

PackageDimensionsUnit String False

The unit of length.

PackageWidth Decimal False

The package width.

PackingGroup String False

The specific packaging group of the item being shipped.

PackingInstruction String False

The specific packing instruction of the item being shipped.

PredefinedPackageDimensions String False

An enumeration of predefined parcel tokens.

Quantity Decimal False

The number of items.

RateAmount Decimal False

The currency amount.

RateCurrencyCode String False

Three-digit currency code in ISO 4217 format.

RequiresAdditionalSellerInputs Bool False

When true, additional seller inputs are required.

SellerOrderId String False

A seller-defined order identifier.

ShipFromAddressLine1 String False

The street address information.

ShipFromAddressLine2 String False

Additional street address information.

ShipFromAddressLine3 String False

Additional street address information.

ShipFromAddressCity String False

The city.

ShipFromAddressCountryCode String False

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

ShipFromAddressDistrictOrCounty String False

The district or county.

ShipFromAddressEmail String False

The email address.

ShipFromAddressName String False

The name of the addressee, or business name.

ShipFromAddressPhone String False

The phone number.

ShipFromAddressPostalCode String False

The zip code or postal code.

ShipFromAddressStateOrProvinceCode String False

The state or province code.

ShipToAddressLine1 String False

The street address information.

ShipToAddressLine2 String False

Additional street address information.

ShipToAddressLine3 String False

Additional street address information.

ShipToAddressCity String False

The city.

ShipToAddressCountryCode String False

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

ShipToAddressDistrictOrCounty String False

The district or county.

ShipToAddressEmail String False

The email address.

ShipToAddressName String False

The name of the addressee, or business name.

ShipToAddressPhone String False

The phone number.

ShipToAddressPostalCode String False

The zip code or postal code.

ShipToAddressStateOrProvinceCode String False

The state or province code.

ShippingServiceId String False

An Amazon-defined shipping service identifier.

ShippingServiceName String False

A plain text representation of a carrier's shipping service.

ShippingServiceOfferId String False

Identifies a shipping service order made by a carrier.

ShippingServiceOptionsCarrierWillPickUp Bool False

When true, the carrier will pick up the package.

ShippingServiceOptionsCarrierWillPickUpOption String False

Carrier will pick up option.

ShippingServiceOptionsDeclaredValueAmount Decimal False

The currency amount.

ShippingServiceOptionsDeclaredValueCurrencyCode String False

Three-digit currency code in ISO 4217 format.

ShippingServiceOptionsDeliveryExperience String False

The delivery confirmation level.

ShippingServiceOptionsLabelFormat String False

The label format.

ShipDate Datetime False

Date-time formatted timestamp of the ship date.

Status String False

The shipment status.

TrackingId String False

The shipment tracking identifier provided by the carrier.

TransparencyCode String False

The transparency code associated with the item.

TransportationRegulatoryClass String False

The specific regulatory class of the shipped item.

UnitedNationsRegulatoryId String False

The specific UNID of the item being shipped.

WeightValue Decimal False

The weight value.

WeightUnit String False

The unit of weight.

MustArriveByDate Datetime False

Date-time formatted timestamp.

IncludePackingSlipWithLabel Bool False

When true, include a packing slip with the label.

HazmatType String False

Hazardous materials options for a package.

ItemInputList String False

A list of items to use for creating Merchant Fulfilled Shipments.

ShipmentSellerInputsList String False

An additional set of seller inputs required to purchase shipping.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454