| AccessibilityAttributes |
Defines the accessibility details of the access point.
|
| AccessPoint |
Access point details
|
| AccessPoint.AssistanceTypeEnum.Adapter |
|
| AccessPointDetails |
AccessPointDetails object
|
| AccessPointList |
List of relevant Access points requested by shipper.
|
| AccessPointsMap |
Map of type of access point to list of access points
|
| AccessPointType.Adapter |
|
| AccountStatus.Adapter |
|
| AccountType.Adapter |
|
| ActiveAccount |
Active Account Details
|
| ActiveAccounts |
A list of ActiveAccount
|
| Address |
The address.
|
| AmazonOrderDetails |
Amazon order information.
|
| AmazonShipmentDetails |
Amazon shipment information.
|
| AvailableValueAddedServiceGroup |
The value-added services available for purchase with a shipping service offering.
|
| AvailableValueAddedServiceGroupList |
A list of value-added services available for a shipping service offering.
|
| Benefits |
Benefits that are included and excluded for each shipping offer.
|
| CancelShipmentResponse |
Response schema for the cancelShipment operation.
|
| CancelShipmentResult |
The payload for the cancelShipment operation.
|
| Carrier |
Carrier Related Info
|
| CarrierAccount |
Carrier Account details used to fetch rates.
|
| CarrierAccountAttribute |
Attribute Properties required by carrier
|
| CarrierAccountAttributes |
A list of all attributes required by the carrier in order to successfully link the merchant's account
|
| CarrierAccountInput |
Info About CarrierAccountInput
|
| CarrierAccountInputsList |
A list of CarrierAccountInput
|
| CarrierAccounts |
A list of CarrierAccounts
|
| ChannelDetails |
Shipment source channel related information.
|
| ChannelType.Adapter |
|
| ChargeComponent |
The type and amount of a charge applied on a package.
|
| ChargeComponent.ChargeTypeEnum.Adapter |
|
| ChargeList |
A list of charges based on the shipping service charges applied on a package.
|
| ClaimProofURLs |
A list of proof URLs for a claim.
|
| ClaimReason.Adapter |
|
| ClientReferenceDetail |
Client Reference Details
|
| ClientReferenceDetail.ClientReferenceTypeEnum.Adapter |
|
| ClientReferenceDetails |
Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
|
| CollectionFormsHistoryRecord |
Active Account Details
|
| CollectionFormsHistoryRecordList |
A list of CollectionFormsHistoryRecord
|
| CollectionsFormDocument |
Collection Form Document Details
|
| CollectOnDelivery |
The amount to collect on delivery.
|
| CreateClaimRequest |
The request schema for the CreateClaim operation
|
| CreateClaimResponse |
The response schema for the createClaim operation.
|
| Currency |
The monetary value in the currency indicated, in ISO 4217 standard format.
|
| DangerousGoodsDetails |
Details related to any dangerous goods/items that are being shipped.
|
| DangerousGoodsDetails.PackingGroupEnum.Adapter |
|
| DangerousGoodsDetails.PackingInstructionEnum.Adapter |
|
| DateRange |
Date Range for query the results.
|
| DayOfWeekTimeMap |
Map of day of the week to operating hours of that day
|
| DetailCodes.Adapter |
|
| Dimensions |
A set of measurements for a three-dimensional object.
|
| Dimensions.UnitEnum.Adapter |
|
| DirectFulfillmentItemIdentifiers |
Item identifiers for an item in a direct fulfillment shipment.
|
| DirectPurchaseRequest |
The request schema for the directPurchaseShipment operation.
|
| DirectPurchaseResponse |
The response schema for the directPurchaseShipment operation.
|
| DirectPurchaseResult |
The payload for the directPurchaseShipment operation.
|
| DocumentFormat.Adapter |
|
| DocumentSize |
The size dimensions of the label.
|
| DocumentSize.UnitEnum.Adapter |
|
| DocumentType.Adapter |
|
| Error |
Error response returned when the request is unsuccessful.
|
| ErrorList |
A list of error responses returned when a request is unsuccessful.
|
| Event |
A tracking event.
|
| EventCode.Adapter |
|
| ExceptionOperatingHours |
Defines exceptions to standard operating hours for certain date ranges.
|
| ExcludedBenefit |
Object representing a benefit that is excluded for a shipping offer or rate.
|
| ExcludedBenefitReasonCodes |
List of reasons (eg.
|
| ExcludedBenefits |
A list of excluded benefit.
|
| GenerateCollectionFormRequest |
The request schema Call to generate the collection form.
|
| GenerateCollectionFormResponse |
The Response for the GenerateCollectionFormResponse operation.
|
| GenerationStatus.Adapter |
|
| Geocode |
Defines the latitude and longitude of the access point.
|
| GetAccessPointsResponse |
The response schema for the GetAccessPoints operation.
|
| GetAccessPointsResult |
The payload for the GetAccessPoints API.
|
| GetAdditionalInputsResponse |
The response schema for the getAdditionalInputs operation.
|
| GetAdditionalInputsResult |
The JSON schema to use to provide additional inputs when required to purchase a shipping offering.
|
| GetCarrierAccountFormInputsResponse |
The Response for the GetCarrierAccountFormInputsResponse operation.
|
| GetCarrierAccountsRequest |
The request schema for the GetCarrierAccounts operation.
|
| GetCarrierAccountsResponse |
The Response for the GetCarrierAccountsResponse operation.
|
| GetCollectionFormHistoryRequest |
The request schema to get query collections form history API .
|
| GetCollectionFormHistoryResponse |
The Response for the GetCollectionFormHistoryResponse operation.
|
| GetCollectionFormResponse |
The Response for the GetCollectionFormResponse operation.
|
| GetRatesRequest |
The request schema for the getRates operation.
|
| GetRatesResponse |
The response schema for the getRates operation.
|
| GetRatesResult |
The payload for the getRates operation.
|
| GetShipmentDocumentsResponse |
The response schema for the the getShipmentDocuments operation.
|
| GetShipmentDocumentsResult |
The payload for the getShipmentDocuments operation.
|
| GetTrackingResponse |
The response schema for the getTracking operation.
|
| GetTrackingResult |
The payload for the getTracking operation.
|
| GetUnmanifestedShipmentsRequest |
The request schema for the GetUnmanifestedShipmentsRequest operation.
|
| GetUnmanifestedShipmentsResponse |
The Response for the GetUnmanifestedShipmentsResponse operation.
|
| GoodsOwner |
The seller owning the goods before handing them over to the carrier
|
| IncludedBenefits |
A list of included benefits.
|
| IneligibilityReason |
The reason why a shipping service offering is ineligible.
|
| IneligibilityReasonCode.Adapter |
|
| IneligibleRate |
Detailed information for an ineligible shipping service offering.
|
| IneligibleRateList |
A list of ineligible shipping service offerings.
|
| InputType.Adapter |
|
| InvoiceDetails |
The invoice details for charges associated with the goods in the package.
|
| Item |
An item in a package.
|
| ItemList |
A list of items.
|
| LabelAttribute.Adapter |
|
| LinkableAccountType |
Info About Linkable Account Type
|
| LinkableAccountTypeList |
A list of LinkableAccountType
|
| LinkableCarrier |
Info About Linkable Carrier
|
| LinkableCarriersList |
A list of LinkableCarrier
|
| LinkCarrierAccountRequest |
The request schema for verify and add the merchant's account with a certain carrier.
|
| LinkCarrierAccountResponse |
The Response for the LinkCarrierAccount operation.
|
| LiquidVolume |
Liquid Volume.
|
| LiquidVolume.UnitEnum.Adapter |
|
| Location |
The location where the person, business or institution is located.
|
| ModelPackage |
A package to be shipped through a shipping service offering.
|
| NdrAction.Adapter |
|
| NdrRequestData |
Additional information required for the NDR action that has been filed.
|
| OneClickShipmentRequest |
The request schema for the OneClickShipment operation.
|
| OneClickShipmentResponse |
The response schema for the OneClickShipment operation.
|
| OneClickShipmentResult |
The payload for the OneClickShipment API.
|
| OneClickShipmentValueAddedService |
A value-added service to be applied to a shipping service purchase.
|
| OneClickShipmentValueAddedServiceDetails |
The value-added services to be added to a shipping service purchase.
|
| OperatingHours |
The hours in which the access point shall remain operational
|
| PackageDocument |
A document related to a package.
|
| PackageDocumentDetail |
The post-purchase details of a package that will be shipped using a shipping service.
|
| PackageDocumentDetailList |
A list of post-purchase details about a package that will be shipped using a shipping service.
|
| PackageDocumentList |
A list of documents related to a package.
|
| PackageList |
A list of packages to be shipped through a shipping service offering.
|
| PaymentType.Adapter |
|
| PrintOption |
The format options available for a label.
|
| PrintOptionList |
A list of the format options for a label.
|
| Promise |
The time windows promised for pickup and delivery events.
|
| PurchaseShipmentRequest |
The request schema for the purchaseShipment operation.
|
| PurchaseShipmentResponse |
The response schema for the purchaseShipment operation.
|
| PurchaseShipmentResult |
The payload for the purchaseShipment operation.
|
| Rate |
The details of a shipping service offering.
|
| RateItem |
Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition:
|
| RateItemID.Adapter |
|
| RateItemList |
A list of RateItem
|
| RateItemType.Adapter |
|
| RateList |
A list of eligible shipping service offerings.
|
| RequestAttributes |
Specify the type of attributes to be added on a label.
|
| RequestedDocumentSpecification |
The document specifications requested.
|
| RequestedLabelCustomization |
Object contains customised data requested by a shipper to be printed on a shipping label.
|
| RequestedValueAddedService |
A value-added service to be applied to a shipping service purchase.
|
| RequestedValueAddedServiceList |
The value-added services to be added to a shipping service purchase.
|
| Service |
Service Related Info
|
| ServiceIds |
A list of ServiceId.
|
| ServiceSelection |
Service Selection Criteria.
|
| SettlementType.Adapter |
|
| ShipmentType.Adapter |
|
| ShipperInstruction |
The shipper instruction.
|
| Status.Adapter |
|
| SubmitNdrFeedbackRequest |
The request schema for the NdrFeedback operation
|
| SupportedDocumentDetail |
The supported document types for a service offering.
|
| SupportedDocumentSpecification |
Document specification that is supported for a service offering.
|
| SupportedDocumentSpecificationList |
A list of the document specifications supported for a shipment service offering.
|
| TaxDetail |
Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.
|
| TaxDetailList |
A list of tax detail information.
|
| TaxType.Adapter |
|
| TimeOfDay |
Denotes time of the day, used for defining opening or closing time of access points
|
| TimeWindow |
The start and end time that specifies the time interval of an event.
|
| TrackingDetailCodes |
Contains detail codes that provide additional details related to the forward and return leg of the shipment.
|
| TrackingSummary |
A package status summary.
|
| UnlinkCarrierAccountRequest |
The request schema for remove the Carrier Account associated with the provided merchant.
|
| UnlinkCarrierAccountResponse |
The Response for the UnlinkCarrierAccountResponse operation.
|
| UnmanifestedCarrierInformation |
UnmanifestedCarrierInformation like carrierId CarrierName and Location
|
| UnmanifestedCarrierInformationList |
A list of UnmanifestedCarrierInformation
|
| UnmanifestedShipmentLocation |
UnmanifestedShipmentLocation info
|
| UnmanifestedShipmentLocationList |
A list of UnmanifestedShipmentLocation
|
| ValidationMetadata |
ValidationMetadata Details
|
| ValidationMetadataList |
A list of ValidationMetadata
|
| ValueAddedService |
A value-added service available for purchase with a shipment service offering.
|
| ValueAddedServiceDetails |
A collection of supported value-added services.
|
| Weight |
The weight in the units indicated.
|
| Weight.UnitEnum.Adapter |
|