-
Model
- Partner
- BaseAddress
- BaseReference
- BaseContact
- BaseShipmentTransportation
- BaseTerms
- BaseTransportation
- BaseDate
- ServiceAllowanceCharge
- ServiceAllowanceCharges
- BaseItem
- Amount
- Messages
- BaseMeasurement
- BaseCarrierDetail
- BaseTax
- InvoiceShipment
- BaseItemACK
- BasePricingInformation
- BaseQuantity
- ItemInformation
- Introduction
Amosoft Developer Portal
Reference
Amosoft strives to streamline shipping for online sellers, no matter where they sell their products online. We are continuously adding new marketplaces, shopping carts, and integration tools, because we know the e-commerce space is growing. As a result, we’ve worked hard to provide developer resources to build custom integrations with Amosoft. If you’re interested in becoming a partner of ours, drop us a line by filling out this form and we’ll get in touch.
There are two methods to integrate with Amosoft:
-
Custom Store Integration
-
Amosoft API
EDI 850
Get Count of messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to get the top 50 messages list.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 850
This API is used to create new message by posting the message details as a json.
Update 850
This API is used to update message by posting the message details as a json.
EDI 856
Get Count of 856 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by Shipment number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 856
This API is used to create new message by posting the message details as a json.
Update 856
This API is used to update message by posting the message details as a json.
EDI 810
Get Count of 810 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by Shipment number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 810
This API is used to create new message by posting the message details as a json.
Update 810
This API is used to update message by posting the message details as a json.
EDI 855
Get Count of 855 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by Purchase order number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 855
This API is used to create new message by posting the message details as a json.
Update 855
This API is used to update message by posting the message details as a json.
EDI 846
Get Count of 846 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by Report Id.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 846
This API is used to create new message by posting the message details as a json.
Update 846
This API is used to update message by posting the message details as a json.
EDI 860
Get Count of 860 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by PO number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 860
This API is used to create new message by posting the message details as a json.
Update 860
This API is used to update message by posting the message details as a json.
EDI 865
Get Count of 865 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by PO number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 865
This API is used to create new message by posting the message details as a json.
Update 865
This API is used to update message by posting the message details as a json.
EDI 753
Get Count of 753 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by PO number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 753
This API is used to create new message by posting the message details as a json.
Update 753
This API is used to update message by posting the message details as a json.
EDI 754
Get Count of 754 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search message by PO number.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 754
This API is used to create new message by posting the message details as a json.
Update 754
This API is used to update message by posting the message details as a json.
EDI 820
Get Count of 820 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 820
This API is used to create new message by posting the message details as a json.
Update 820
This API is used to update message by posting the message details as a json.
EDI 214
Get Count of 214 messages
This API is used to get count of all messages.
This API is used to get count of all messages.
Get Messages
This API is used to get the top 50 messages list.
This API is used to search all messages before messsage id specified. We will get all the messages with message id less than message id specified in parameter.
This API is used to search all messages after messsage id specified. We will get all the messages with message id greater than message id specified in parameter.
This API is used to search messages for different parameters specified. Here, we can specify id as message id, partner name to get messages for that partner. Along with this we can specify the minid and maxid to get the messages between the two message id's.
Create 214
This API is used to create new message by posting the message details as a json.
Update 214
This API is used to update message by posting the message details as a json.
Model
Model - Partner
| Name | Data Type | Description |
|---|---|---|
PartnerName |
string, required | Name of the Partner. |
PartnerLocation |
string, optional | Location of the Partner. |
Model - BaseAddress
| Name | Data Type | Description |
|---|---|---|
Name |
string, required | Name of the address holder. |
Code |
string, optional | Code. |
AdditionalName1 |
string, optional | Additional Name. |
AdditionalName2 |
string, optional | Additional name. |
Address1 |
string, optional | Address line. |
Address2 |
string, optional | Address line. |
Address3 |
string, optional | Address line. |
City |
string, optional | City of the address. |
County |
string, optional | County of the address. |
District |
string, optional | District of the address. |
State |
string, optional | State of the address. |
PostalCode |
string, optional | Postal Code of the address. |
Country |
string, optional | Country of the address. |
EntityType |
string, optional, Values | Type of the address. |
Model - BaseReference
| Name | Data Type | Description |
|---|---|---|
StoreNumber |
string, optional | Store number. |
CustomerOrderNumber |
string, optional | Order number |
VendorOrderNumber |
string, optional | Vendor number |
CustomerReferenceNumber |
string, optional | Customer reference number |
VendorIDNumber |
string, optional | VendorID number |
DeptartmentNumber |
string, optional | Department number |
BuyerNumber |
string, optional | Buyer number |
InternalVendorNumber |
string, optional | Internal vendor number |
BOL |
string, optional | Beginning Segment for the Motor Carrier Bill of Lading |
CarrierReferenceNumber |
string, optional | Carrier details |
Payment | string, optional | Amazon Seller Central Payment |
PaymentCurrency | string, optional | Amazon Seller Central PaymentCurrency |
PaymentMethod | string, optional | Amazon Seller Central PaymentMethod |
BuyerCustomizedURL | string, optional | Amazon Seller Central BuyerCustomizedURL |
Title | string, optional | Amazon Seller Central Title |
QuantityShipped | string, optional | Amazon Seller Central QuantityShipped |
PointsGrantedNumber | string, optional | Amazon Seller Central PointsGrantedNumber |
PointsGrantedCurrencyCode | string, optional | Amazon Seller Central PointsGrantedCurrencyCode |
PointsGrantedAmount | string, optional | Amazon Seller Central PointsGrantedAmount |
NumberOfItems | string, optional | Amazon Seller Central NumberOfItems |
ItemPriceCurrencyCode | string, optional | Amazon Seller Central ItemPriceCurrencyCode |
ShippingPriceCurrencyCode | string, optional | Amazon Seller Central ShippingPriceCurrencyCode |
ShippingPriceAmount | string, optional | Amazon Seller Central ShippingPriceAmount |
GiftWrapPriceCurrencyCode | string, optional | Amazon Seller Central GiftWrapPriceCurrencyCode |
GiftWrapPriceAmount | string, optional | Amazon Seller Central GiftWrapPriceAmount |
ShippingTaxCurrencyCode | string, optional | Amazon Seller Central ShippingTaxCurrencyCode |
ShippingTaxAmount | string, optional | Amazon Seller Central ShippingTaxAmount |
GiftWrapTaxCurrencyCode | string, optional | Amazon Seller Central GiftWrapTaxCurrencyCode |
GiftWrapTaxAmount | string, optional | Amazon Seller Central GiftWrapTaxAmount |
ShippingDiscountCurrencyCode | string, optional | Amazon Seller Central ShippingDiscountCurrencyCode |
ShippingDiscountAmount | string, optional | Amazon Seller Central ShippingDiscountAmount |
PromotionDiscountCurrencyCode | string, optional | Amazon Seller Central PromotionDiscountCurrencyCode |
PromotionDiscountAmount | string, optional | Amazon Seller Central PromotionDiscountAmount |
CODFeeCurrencyCode | string, optional | Amazon Seller Central CODFeeCurrencyCode |
CODFeeAmount | string, optional | Amazon Seller Central CODFeeAmount |
CODFeeDiscountCurrencyCode | string, optional | Amazon Seller Central CODFeeDiscountCurrencyCode |
CODFeeDiscountAmount | string, optional | Amazon Seller Central CODFeeDiscountAmount |
GiftMessageText | string, optional | Amazon Seller Central GiftMessageText |
GiftWrapLevel | string, optional | Amazon Seller Central GiftWrapLevel |
InvoiceRequirement | string, optional | Amazon Seller Central InvoiceRequirement |
BuyerSelectedInvoiceCategory | string, optional | Amazon Seller Central BuyerSelectedInvoiceCategory |
InvoiceTitle | string, optional | Amazon Seller Central InvoiceTitle |
InvoiceInformation | string, optional | Amazon Seller Central InvoiceInformation |
ConditionNote | string, optional | Amazon Seller Central ConditionNote |
ConditionId | string, optional | Amazon Seller Central ConditionId |
ConditionSubtypeId | string, optional | Amazon Seller Central ConditionSubtypeId |
ScheduledDeliveryStartDate | string, optional | Amazon Seller Central ScheduledDeliveryStartDate |
ScheduledDeliveryEndDate | string, optional | Amazon Seller Central ScheduledDeliveryEndDate |
PriceDesignation | string, optional | Amazon Seller Central PriceDesignation |
FullFillmentChannel | string, optional | FullFillmentChannel |
SalesChannel | string, optional | SalesChannel |
MarketplaceId | string, optional | MarketplaceId |
ShipServiceLevel | string, optional | ShipServiceLevel |
ShipmentServiceLevelCategory | string, optional | ShipmentServiceLevelCategory |
BookingNumber | string, optional | Booking Number |
ConsigneeOrderNumber | string, optional | Consignee Order Number |
PurchaseOrderNumber | string, optional | Purchase Order Number |
ShipperIdentifyingNumberForShipment | string, optional | Shipper Identifying Number For Shipment |
TransportationControlNumber | string, optional | Transportation Control Number |
Supplier | string, optional | Supplier |
IdentityCardNumber | string, optional | Identity Card Number |
PickupReferenceNumber | string, optional | Pickup Reference Number |
TankNumber | string, optional | Tank Number |
Model - BaseContact
| Name | Data Type | Description |
|---|---|---|
Function |
string, optional | Contact function code. |
ContactName |
string, optional | Contact Name. |
ContactPhone |
string, optional | Contact Phone number. |
ContactFax |
string, optional | Contact Fax number. |
ContactEmail |
string, optional | Contact EmailId. |
Model - BaseShipmentTransportation
| Name | Data Type | Description |
|---|---|---|
ShipmentPaymentMethod |
string, optional | Shipment Payment Method. |
Location |
string, optional | Location. |
Model - BaseTerms
| Name | Data Type | Description |
|---|---|---|
TermsType |
string, optional | Terms type code. |
TermsBaseDate |
string, optional | Terms basis date code. |
DiscountPercent |
string, optional | Terms discount percent. |
DiscountDueDate |
string, optional | Terms discount due date. |
DiscountDaysDue |
string, optional | Terms discount days due. |
NetDueDate |
string, optional | Terms net due date. |
NetDays |
string, optional | Terms net days. |
DiscountAmount |
string, optional | Discount amount. |
DeferredDueDate |
string, optional | Deferred due date. |
DeferredAmountDue |
string, optional | Deferred due amount. |
PercentOfInvoicePayable |
string, optional | Percent of invoice payable. |
Description |
string, optional | Description. |
DaysOfMonth |
string, optional | Days of month. |
PaymentMethodCode |
string, optional | Payment method code. |
Percent |
string, optional | Percent. |
Model - BaseTransportation
| Name | Data Type | Description |
|---|---|---|
SCAC |
string, optional | Standard Carrier Alpha Code. |
TransportationMethod |
string, optional | Transportation Method. |
Routing |
string, optional | Routing. |
ServiceLevel |
string, optional | Service Level code. |
CountryCode |
string, optional | Country Code. |
Model - BaseDate
| Name | Data Type | Description |
|---|---|---|
CancelAfter |
string, optional | Cancel After. |
DeliveryRequested |
string, optional | Delivery Requested. |
RequestedShip |
string, optional | Requested shipment date. |
ShipNotBefore |
string, optional | Ship not before date. |
ShipNoLater |
string, optional | Ship no later date. |
CancelifNotDeliveredBy |
string, optional | Cancel if not delivered by date. |
ScheduleShip |
string, optional | Scheduled shipment date. |
ScheduledForDelivery |
string, optional | Scheduled for delivery. |
ShippedDate |
string, optional | Shipped date. |
EstimatedDeliveryDate |
string, optional | Estimated delivery date. |
EstimatedArrivalDate |
string, optional | Estimated Arrival date. |
CurrentScheduleDeliveryDate |
string, optional | Current scheduled delivery date. |
RequestedShipDatePickUpDate |
string, optional | Requested Ship Date Pick Up Date. |
ScheduledPickupDate |
string, optional | Scheduled Pickup Date. |
DeliverNotBeforeDate |
string, optional | Deliver Not Before Date. |
DeliverNoLaterThanDate |
string, optional | Deliver No Later Than Date. |
ScheduledDeliveryDate |
string, optional | Scheduled Delivery Date. |
ShippedOnThisDate |
string, optional | Shipped On This Date. |
Model - ServiceAllowanceCharge
| Name | Data Type | Description |
|---|---|---|
Type |
string, optional | Type. |
Percent |
string, optional | Percent. |
Code |
string, optional | Code. |
AgencyType |
string, optional | Ahency Type. |
AgencyCode |
string, optional | Agency Code. |
PercentType |
string, optional | Percent type. |
Rate |
string, optional | Rate. |
UOM |
string, optional | Type. |
Quantity |
string, optional | Quantity. |
MethodOfHandling |
string, optional | Method of handling. |
Reference |
string, optional | Reference. |
OptionNumber |
string, optional | Option number. |
Description |
string, optional | Description. |
LanguageCode |
string, optional | Language code. |
Amount |
string, optional | Amount. |
Model - ServiceAllowanceCharges
| Name | Data Type | Description |
|---|---|---|
ServiceAllowanceCharge |
List Of BaseServiceAllowanceCharge, optional | List of ServiceallowanceCharge object. |
Model - BaseItem
| Name | Data Type | Description |
|---|---|---|
LineNumber |
string, Optional | Line Number. |
ItemCode |
string, required | Code of Item. |
ItemName |
string, required | ItemName. |
Quantity |
string, required | Quantity. |
Price |
string, required | Price. |
BuyerPartNumber |
string, optional | BuyerPartNumber. |
VendorPartNumber |
string, optional | VendorPartNumber. |
UPC |
string, optional | UPC. |
SKU |
string, optional | SKU. |
EAN |
string, optional | EAN. |
ISBN |
string, optional | ISBN. |
Pack |
string, optional | Pack. |
Size |
string, optional | Size. |
Weight |
string, optional | Weight. |
Height |
string, optional | Height. |
Length |
string, optional | Length. |
Model - Amount
| Name | Data Type | Description |
|---|---|---|
AmountType |
string, optional | Account qualifier code. |
Amount |
string, optional | Amount. |
CrDrFlag |
string, optional | Credit / Debit flag. |
Model - Messages
| Name | Data Type | Description |
|---|---|---|
Message |
string, optional | Message description. |
Model - BaseMeasurement
| Name | Data Type | Description |
|---|---|---|
GrossWeight |
string, optional | Gross Weight. |
NetWeight |
string, optional | Net Weight. |
WeightUOM |
string, optional | Weight Unit Of Measurement. |
Length |
string, optional | Length. |
LengthUOM |
string, optional | Length unit of measurement. |
Height |
string, optional | Height. |
Height |
string, optional | Height unit of measurement. |
Width |
string, optional | Width. |
WidthUOM |
string, optional | Width units of measurement. |
Model - BaseCarrierDetail
| Name | Data Type | Description |
|---|---|---|
TransportType |
string, optional | Transport Type. |
EquipmentInitial |
string, optional | EquipmentInitial. |
EquipmentNumber |
string, optional | Equipment Number. |
SCAC |
string, optional | SCAC. |
Routing |
string, optional | Routing. |
ShipOrderStatus |
string, optional | Shipping Order Status. |
ReferenceIDType |
string, optional | ReferenceID Type. |
ReferenceID |
string, optional | ReferenceID. |
ServiceLevel |
string, optional | ServiceLevel. |
Model - BaseTax
| Name | Data Type | Description |
|---|---|---|
TaxCode |
string, optional | TaxCode. |
TaxAmount |
string, optional | Tax Amount. |
TaxPercent |
string, optional | Tax Percent. |
TaxJurisType |
string, optional | TaxJuris Type. |
TaxJurisCode |
string, optional | TaxJuris Code. |
TaxExemptCode |
string, optional | Tax Exempt Code. |
PriceRelateCode |
string, optional | PriceRelate Code. |
DollarBasisForPercent |
string, optional | Dollar Basis For Percent. |
TaxIDNumber |
string, optional | TaxID Number. |
AssignedID |
string, optional | Assigned ID. |
Model - InvoiceShipment
| Name | Data Type | Description |
|---|---|---|
NumberOfUnitsShipped |
string, optional | Number Of Units Shipped. |
Weight |
string, optional | Weight. |
Model - BaseItemACK
| Name | Data Type | Description |
|---|---|---|
Status |
string, optional | Acknowledgement status. |
Quantity |
string, optional | Quantity. |
CurrentScheduleShipDate |
string, optional | Current Schedule ShipDate. |
CurrentScheduleDeliveryDate |
string, optional | Current Schedule DeliveryDate. |
PromisedForShipmentDate |
string, optional | Promised For ShipmentDate. |
CustomDate |
string, optional | Custom Date. |
Model - BasePricingInformation
| Name | Data Type | Description |
|---|---|---|
TradeCode |
string, optional | Trade Code. |
PriceCode |
string, optional | Price Code. |
UnitPrice |
string, optional | Unit Price. |
Model - BaseQuantity
| Name | Data Type | Description |
|---|---|---|
QuantityOnHand |
string, optional | Quantity On Hand. |
QuantityUnusable |
string, optional | Quantity Unusable. |
QuantityInTransit |
string, optional | Quantity In Transit. |
QuantityAvailableForSale |
string, optional | Quantity Available For Sale. |
QuantityOther |
string, optional | Quantity Other. |
Model - ItemInformation
| Name | Data Type | Description |
|---|---|---|
QuantityType |
string, optional | QuantityType. |
Quantity |
string, optional | Quantity. |
QuantityDescription |
string, optional | Quantity Description. |
WeightType |
string, optional | Weight Type. |
WeightUOM |
string, optional | Unit of Weight. |
Weight |
string, optional | Weight. |
VolumeUnit |
string, optional | Unit of Volume. |
Volume |
string, optional | Volume. |
Model EDI X12
Model - MSG850HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
POPurpose |
string, optional, Values | Purpose of the PO. |
POType |
string, optional, Values | Type of the PO. |
PONumber |
string, required | Number of the PO. |
ReleaseNumber |
string, optional | Release Number. |
PODate |
string, required | Date of the PO. |
ShipTo |
BaseAddress, required | Ship to address. |
BillTo |
BaseAddress, required | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
References |
BaseReference, optional | References numbers. |
ContactDetails |
BaseContact, required | Contact Details. |
ShipmentTransportationDetails |
BaseShipmentTransportation, optional | Shipment Transportation Details. |
Terms |
BaseTerms, optional | Terms details. |
TransportationDetails |
BaseTransportation, optional | Transportation details. |
Dates |
BaseDate, optional | Date details. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
Amount |
Amount, optional | Amount details. |
Message |
Messages, optional | Messages details. |
ItemList |
ItemList, optional | MSG 850 Items details. |
Model - MSG850DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD850 table. |
item |
BaseItem, required | Basic Item details. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
Model - ItemList (850)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG850DT, optional | List of base items. |
Model - MSG856HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
ShipmentNumber |
string, optional | Shipment Number. |
ShipmentDate |
string, optional | Shipment Date. |
ShippedDate |
string, optional | Shipped Date. |
Purpose |
string, optional, Values | Purpose. |
PONumber |
string, optional | PO Number. |
PODate |
string, optional | Date of the PO. |
LadingQuantity |
string, optional | Lading Quantity. |
Dates |
BaseDate, optional | Date details. |
Terms |
BaseTerms, optional | Terms details. |
Measurement |
BaseMeasurement, optional | Measurement details. |
CarrierDetail |
BaseCarrierDetail, optional | BaseCarrier details. |
TransportationDetails |
BaseTransportation, optional | Transportation details. |
References |
BaseReference, optional | References numbers. |
ContactDetails |
BaseContact, optional | Contact Details. |
ShipmentTransportationDetails |
BaseShipmentTransportation, optional | Shipment Transportation Details. |
ShipTo |
BaseAddress, optional | Ship to address. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
ItemList |
ItemList, optional | MSG 856 Items details. |
Model - MSG856DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD856 table. |
CartonNumber |
string, optional | Carton Number. |
PalletNumber |
string, optional | Pallet Number. |
item |
BaseItem, required | Basic Item details. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
Model - ItemList (856)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG856DT, optional | List of base items. |
Model - MSG810HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
InvoiceNumber |
string, optional | Invoice Number. |
ShipmentDate |
string, optional | Shipment Date. |
InvoiceDate |
string, optional | Invoice Date. |
InvoiceType |
string, optional, Values | Invoice Type. |
PONumber |
string, optional | PO Number. |
PODate |
string, optional | PO Date. |
ReleaseNumber |
string, optional | Release Number. |
Amount |
string, optional | Amount. |
BaseAmount |
string, optional | Base Amount. |
AmountDue |
string, optional | Amount due. |
Discount |
string, optional | Discount amount. |
ShipTo |
BaseAddress, optional | Ship to address. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
References |
BaseReference, optional | References numbers. |
ContactDetails |
BaseContact, optional | Contact Details. |
ShipmentTransportationDetails |
BaseShipmentTransportation, optional | Shipment Transportation Details. |
Terms |
BaseTerms, optional | Terms details. |
Dates |
BaseDate, optional | Date details. |
Tax |
BaseTax, optional | Basic tax details. |
CarrierDetail |
BaseCarrierDetail, optional | BaseCarrier details. |
TransportationDetails |
BaseTransportation, optional | Transportation details. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
InvoiceShipment |
InvoiceShipment, optional | Invoice Shipment details. |
ItemList |
ItemList, optional | MSG 810 Items details. |
Model - MSG810DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD810 table. |
item |
BaseItem, required | Basic Item details. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
Model - ItemList (810)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG810DT, optional | List of base items. |
Model - MSG855HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
PurposeCode |
string, optional, Values | Purpose Code. |
AckType |
string, optional, Values | Acknowledgement Type. |
PONumber |
string, optional | PO Number. |
ReleaseNumber |
string, optional | Release Number. |
PODate |
string, optional | PO Date. |
PO_AckDate |
string, optional | Purchase Order Acknowledgement Date. |
RequestRefNumber |
string, optional | Request Reference Number. |
ContractNumber |
string, optional | Contract Number. |
ReferenceID |
string, optional | Reference ID. |
OtherDate |
string, optional | Other Date. |
TransType |
string, optional | Transport Type. |
References |
BaseReference, optional | References numbers. |
Dates |
BaseDate, optional | Date details. |
ShipTo |
BaseAddress, optional | Ship to address. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
Terms |
BaseTerms, optional | Terms details. |
TransportationDetails |
BaseTransportation, optional | Transportation details. |
ItemList |
ItemList, optional | MSG 855 Items details. |
Model - MSG855DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD855 table. |
item |
BaseItem, required | Basic Item details. |
ItemTotal |
int, required | Total of all items. |
BaseItemACK |
BaseItemACK, optional | Base Item Acknowledgement. |
Dates |
BaseDate, optional | Base Dates. |
BasePricingInfo |
BasePricingInformation, optional | Base Pricing Information. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
ManufactureNames |
BaseAddress, optional | Manufacture Names. |
Other |
BaseAddress, optional | Other details. |
reference |
BaseReference, optional | Base References. |
Model - ItemList (855)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG855DT, optional | List of base items. |
Model - MSG846HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
ReportID |
string, optional | Report ID. |
ReportDate |
string, optional | Report Date. |
References |
BaseReference, optional | References numbers. |
ItemList |
ItemList, optional | MSG 846 Items details. |
Model - MSG846DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD846 table. |
item |
BaseItem, required | Basic Item details. |
Quantity |
BaseQuantity, required | Basic quantity details. |
Model - ItemList (846)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG846DT, optional | List of base items. |
Model - MSG860HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
Status |
string, optional | Status. |
POType |
string, optional | Purchase order type. |
PONumber |
string, optional | Purchase order number. |
SequanceNo |
string, optional | Sequance Number. |
PODate |
string, optional | Purchase order date. |
ReleaseNumber |
string, optional | Release Number. |
ChangeDate |
string, optional | Change date. |
RefNumber |
string, optional | Reference Number. |
RefID |
string, optional | Reference ID. |
References |
BaseReference, optional | References numbers. |
Dates |
BaseDate, optional | Base date values. |
ServiceAllowanceCharges |
ServiceAllowanceCharges, optional | Service allowance charges details. |
TransportationDetails |
BaseTransportation, optional | Transportation details. |
ShipTo |
BaseAddress, optional | Ship to address. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
MarkFor |
BaseAddress, optional | MarkFor address. |
ContactDetails |
BaseContact, optional | Contact Details. |
ShipmentTransportationDetails |
BaseShipmentTransportation, optional | Shipment Transportation Details. |
Message |
Messages, optional | Message. |
ItemList |
ItemList, optional | MSG 860 Items details. |
Model - MSG860DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD860 table. |
item |
BaseItem, required | Basic Item details. |
Model - ItemList (860)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG860DT, optional | List of base items. |
Model - MSG865HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
Status |
string, optional | Status. |
AckType |
string, optional | Acknowledgement type. |
PONumber |
string, optional | Purchase order number. |
PODate |
string, optional | Purchase order date. |
ReleaseNumber |
string, optional | Release Number. |
SequenceNumber |
string, optional | Sequence Number. |
References |
BaseReference, optional | References numbers. |
Dates |
BaseDate, optional | Base date values. |
ShipTo |
BaseAddress, optional | Ship to address. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipFrom |
BaseAddress, optional | Ship From address. |
RemitTo |
BaseAddress, optional | Remit to address. |
Vendors |
BaseAddress, optional | Vendors address. |
Suppliers |
BaseAddress, optional | Suppliers address. |
Stores |
BaseAddress, optional | Stores address. |
Buyers |
BaseAddress, optional | Buyers address. |
MarkFor |
BaseAddress, optional | MarkFor address. |
ItemList |
ItemList, optional | MSG 865 Items details. |
Model - MSG865DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD865 table. |
item |
BaseItem, required | Basic Item details. |
Model - ItemList (865)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG865DT, optional | List of base items. |
Model - MSG753HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
POPurpose |
string, optional | Purchase Order Purpose. |
ShippingRoutingRequestID |
string, optional | ShippingRoutingRequestID. |
ShippingDate |
string, optional | Shipping Date. |
ContactDetails |
BaseContact, required | Contact Details. |
ShipFrom |
BaseAddress, optional | ShipFrom address. |
ItemList |
ItemList, optional | MSG 753 Items details. |
Model - MSG753DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD753 table. |
LineNumber |
string, optional | LineNumber. |
BOL |
string, optional | Bill of landing. |
BOLDescription |
string, optional | Bill of landing description. |
PickupDate |
string, optional | Pickup Date. |
PickupTMZ |
string, optional | PickupTMZ. |
USIQuantity |
string, optional | Unitised shipment quantity. |
USIPackagingForm |
string, optional | Unitised shipment packaging form. |
USIResponse |
string, optional | Unitised shipment response. |
OIDPOnumber |
string, optional | Purchase Order number. |
OIDPackagingForm |
string, optional | PackagingForm. |
OIDQuantity |
string, optional | Quantity. |
OIDWeightUnit |
string, optional | Weight measurement unit. |
OIDWeight |
string, optional | Weight. |
OIDVolumeUnit |
string, optional | Volume Measurement Unit. |
OIDVolume |
string, optional | Volume. |
CommodityCode |
string, optional | Commodity Code. |
FreightClass |
string, optional | Freight Class. |
ShipTo |
BaseAddress, required | Ship to address. |
Model - ItemList (753)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG753DT, optional | List of base items. |
Model - MSG754HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
POPurpose |
string, optional | Purchase Order Purpose. |
ShippingRoutingRequestID |
string, optional | ShippingRoutingRequestID. |
ShippingDate |
string, optional | Shipping Date. |
ContactDetails |
BaseContact, required | Contact Details. |
ShipFrom |
BaseAddress, optional | ShipFrom address. |
Carrier |
BaseAddress, optional | Carrier address. |
ItemList |
ItemList, optional | MSG 754 Items details. |
Model - MSG754DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD754 table. |
LineNumber |
string, optional | LineNumber. |
BOL |
string, optional | Bill of landing. |
BOLDescription |
string, optional | Bill of landing description. |
PONumber |
string, optional | Purchase Order number. |
PackagingForm |
string, optional | PackagingForm. |
OIDQuantity |
string, optional | Quantity ordered. |
WeightUnit |
string, optional | Unit of weight measurement. |
Weight |
string, optional | Weight. |
VolumeUnit |
string, optional | Unit of Volume measurement. |
Volume |
string, optional | Volume. |
G62PickupDate |
string, optional | Pickup Date. |
G62PickupTMZ |
string, optional | G62PickupTMZ. |
ShipTo |
BaseAddress, required | Ship to address. |
ItemInformations |
List Of ItemInformation, optional | List of ItemInformation object. |
Model - ItemList (754)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG754DT, optional | List of base items. |
Model - MSG820HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
TransactionHandlingCode |
string, optional | Transaction Handling Code. |
MonetaryAmount |
string, optional | Monetary Amount. |
CreditOrDebitFlagCode |
string, optional | Credit Or Debit Flag Code. |
PaymentMethodCode |
string, optional | Payment method code. |
PaymentFormatCode |
string, optional | Payment format code. |
TraceType |
string, optional | Trace type. |
TransactionNumber |
string, optional | Transaction number. |
Dates |
BaseDate, optional | Dates. |
Payee |
BaseAddress, optional | Payee address. |
Payer |
BaseAddress, optional | Payer address. |
ItemList |
ItemList, optional | MSG 820 Items details. |
Model - MSG820DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD820 table. |
LineNumber |
string, optional | LineNumber. |
LineID |
string, optional | LineID. |
InvoiceDate |
BaseDate, optional | InvoiceDate |
item |
MSG820ItemDetails, required | 820 model item details. |
Model - ItemList (820)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG820DT, optional | List of base items. |
Model - MSG820ItemDetails
| Name | Data Type | Description |
|---|---|---|
EntityAssignedNumber |
string, required | Entity assigned number. |
PaidAmount |
string, optional | Paid Amount. |
InvoiceAmount |
string, optional | Invoice Amount. |
Note |
string, optional | Note. |
AdjustmentMonetaryAmount |
string, optional | Adjustment Monetary Amount. |
AdjustmentReason |
string, optional | Adjustment reason. |
AdjustmentReference |
string, optional | Adjustment reference. |
AdjustmentReferenceType |
string, optional | Adjustment reference Type. |
Model - MSG214HD
| Name | Data Type | Description |
|---|---|---|
Partner |
Partner, required | Partner Details. |
InvoiceNumber |
string, optional | Invoice Number. |
ShipmentNumber |
string, optional | Shipment Number. |
SCAC |
string, optional | Standard Carrier Code. |
BOL |
string, optional | Bill of Lading. |
Message |
string, optional | Message. |
BillTo |
BaseAddress, optional | Bill to address. |
ShipTo |
BaseAddress, optional | Ship to address. |
Shipper |
BaseAddress, optional | Shipper address. |
Dates |
BaseDate, optional | Base date values. |
ContactDetails |
BaseContact, optional | Contact Details. |
ItemList |
ItemList, optional | MSG 214 Items details. |
Model - MSG214DT
| Name | Data Type | Description |
|---|---|---|
parent_id |
int, required | RecordId of MSGHD214 table. |
LineNo |
string, optional | Line Number. |
References |
BaseReference, optional | References numbers. |
LadingException |
string, optional | Lading Exception. |
LadingPackaging |
string, optional | Lading Packaging. |
ShippersWeight |
string, optional | Shippers Weight. |
GrossWeight |
string, optional | Gross Weight. |
ActualNetWeight |
string, optional | Actual Net Weight. |
WeightUnit |
string, optional | Weight Unit. |
LadingQuantity1 |
string, optional | Lading Quantity 1. |
LadingQuantity2 |
string, optional | Lading Quantity 2. |
ShipmentStatusType |
string, optional | Shipment Status Type. |
ShipmentStatus1 |
string, optional | Shipment Status 1. |
ShipmentAppointment |
string, optional | Shipment Appointment. |
ShipmentStatus2 |
string, optional | Shipment Status 2. |
ShipmentStatusDate |
string, optional | Shipment Status Date. |
ShipmentStatusTime |
string, optional | Shipment Status Time. |
ShipmentStatusTimeType |
string, optional | Shipment Status Time Type. |
City |
string, optional | City. |
State |
string, optional | State. |
Country |
string, optional | Country. |
Longitude |
string, optional | Longitude. |
Latitude |
string, optional | Latitude. |
Direction1 |
string, optional | Direction 1. |
Direction2 |
string, optional | Direction 2. |
SCAC |
string, optional | Standard Carrier Code. |
EquipmentNumber |
string, optional | Equipment Number. |
EquipmentDescription |
string, optional | Equipment Description. |
EquipmentCheckDigit |
string, optional | Equipment Check Digit. |
Model - ItemList (214)
| Name | Data Type | Description |
|---|---|---|
items |
List of MSG214DT, optional | List of base items. |
Parameters
Request
Attributes
- Authorization:< Enter your Basic Authorization string here >
- Example given :
- Authorization:bearer {Access_Token}
- Content-Type:application/json;charset=UTF-8
- Accept:application/json
Response
Attributes
- Content-Type : application/json