POST order/importOrder/v4

Action will import the orders into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/order/importOrder/v4

Sandbox Url: https://sandbox-api.freightpop.com/order/importOrder/v4

Request Information

URI Parameters

None.

Body Parameters

Collection of OrderV4Dto
NameDescriptionTypeAdditional information
TransactionType

OrderTransactionType
Optional(Default transaction type is Sales)
OrderType

Order type

string

None.

AutoprocessShipment

Flag to autoprocess shipment

boolean

None.

ShipDate

Ship date in UTC

date

None.

OrderNumber

This variable will be used to bind your order in FreightPop. Must be unique from Previous orders imported.

string

None.

QuoteId

Optional, need to be passed from Rates V3 API. Must not be greater than 10 characters if passed.

string

None.

RateId

Optional, need to be passed from Rates V3 API.

string

None.

CustomerId

Company ID for customers when Logistics Provider flag is turned on. Otherwise it will be ignored.

string

None.

CompanyErpId

Company ERP ID

integer

None.

ShipperAddress

Shipper address

OrderShipperAddressV4

None.

ReturnAddress

Return Address

OrderShipperAddressV4

None.

ConsigneeAddress

Consignee address

OrderConsigneeAddressV4

None.

SoldToAddress

Sold to address

OrderSoldToAddressV4

None.

Items

Product details

Collection of ShipmentItemV4Dto

None.

ProductDetails

Product Details

Collection of ProductDetailV4

None.

ITN

ITN (International Transaction Number)

string

None.

Carrier

Carrier details

CarrierV2

None.

PaymentTerm

Order payment terms

PaymentTerm

None.

ThirdPartyAccountInfo

Third party account details

AccountDetails

None.

Reference1

Reference field 1

string

None.

Reference2

Reference field 2

string

None.

Reference3

Reference field 3

string

None.

Reference4

Reference field 4

string

None.

Reference5

Reference field 5

string

None.

Reference6

Reference field 6

string

None.

AdditionalDetails

Additional details

AdditionalDetailsV4

None.

Documents

Collection of OrderDocumentDto
Optional(Documents for the order)

Request Formats

application/json, text/json

Sample:
[
  {
    "TransactionType": 0,
    "OrderType": "sample string 1",
    "AutoprocessShipment": true,
    "ShipDate": "2024-10-22T04:29:28.778282-07:00",
    "OrderNumber": "sample string 3",
    "QuoteId": "sample string 4",
    "RateId": "sample string 5",
    "CustomerId": "sample string 6",
    "CompanyErpId": 7,
    "ShipperAddress": {
      "CompanyId": "sample string 1",
      "Company": "sample string 2",
      "StoreNumber": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "OpenTime": "sample string 14",
      "CloseTime": "sample string 15",
      "UserDefined1": "sample string 16",
      "UserDefined2": "sample string 17",
      "UserDefined3": "sample string 18",
      "UserDefined4": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7792798-07:00",
      "IncludeReturnLabel": true
    },
    "ReturnAddress": {
      "CompanyId": "sample string 1",
      "Company": "sample string 2",
      "StoreNumber": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "OpenTime": "sample string 14",
      "CloseTime": "sample string 15",
      "UserDefined1": "sample string 16",
      "UserDefined2": "sample string 17",
      "UserDefined3": "sample string 18",
      "UserDefined4": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7792798-07:00",
      "IncludeReturnLabel": true
    },
    "ConsigneeAddress": {
      "CompanyId": "sample string 1",
      "StoreNumber": "sample string 2",
      "TaxIdNumber": "sample string 3",
      "Company": "sample string 4",
      "AttentionTo": "sample string 5",
      "Street1": "sample string 6",
      "Street2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zip": "sample string 10",
      "Country": "sample string 11",
      "Phone": "sample string 12",
      "Email": "sample string 13",
      "CarrierInsuranceAmount": "sample string 14",
      "RequiredArrivalDate": "2024-10-22T04:29:28.7792798-07:00",
      "RequiredShipDate": "2024-10-22T04:29:28.7802792-07:00",
      "OpenTime": "sample string 17",
      "CloseTime": "sample string 18",
      "UserDefined1": "sample string 19",
      "UserDefined2": "sample string 20",
      "UserDefined3": "sample string 21",
      "UserDefined4": "2024-10-22T04:29:28.7802792-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7802792-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7802792-07:00",
      "CanArriveEarly": true,
      "CanShipEarly": true,
      "AllowConsolidations": true
    },
    "SoldToAddress": {
      "CompanyId": "sample string 1",
      "StoreNumber": "sample string 2",
      "Company": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "UserDefined1": "sample string 14",
      "UserDefined2": "sample string 15",
      "UserDefined3": "sample string 16",
      "UserDefined4": "2024-10-22T04:29:28.781277-07:00",
      "UserDefined5": "2024-10-22T04:29:28.781277-07:00",
      "UserDefined6": "2024-10-22T04:29:28.781277-07:00"
    },
    "Items": [
      {
        "Unit": 1,
        "PackageId": "sample string 1",
        "Quantity": 2,
        "PackageType": 1,
        "Length": 3.1,
        "Width": 4.1,
        "Height": 5.1,
        "Weight": 6.1,
        "FreightClass": 7.1,
        "Description": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1,
        "InnerPieces": [
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          },
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          }
        ]
      },
      {
        "Unit": 1,
        "PackageId": "sample string 1",
        "Quantity": 2,
        "PackageType": 1,
        "Length": 3.1,
        "Width": 4.1,
        "Height": 5.1,
        "Weight": 6.1,
        "FreightClass": 7.1,
        "Description": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1,
        "InnerPieces": [
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          },
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          }
        ]
      }
    ],
    "ProductDetails": [
      {
        "Country": "sample string 1",
        "HTSCode": "sample string 2",
        "Description": "sample string 3",
        "Number": "sample string 4",
        "PackageId": "sample string 5",
        "PricePerPiece": 6.0,
        "PricePerPiece2": 7.0,
        "PricePerPiece3": 8.0,
        "PricePerPiece4": 9.0,
        "Quantity": 10,
        "Quantity2": 11,
        "Quantity3": 12,
        "Quantity4": 13,
        "Unit": "sample string 14",
        "OrderNumber": "sample string 15",
        "LineType": "sample string 16",
        "LineNumber": "sample string 17",
        "RequiredShipDate": "2024-10-22T04:29:28.7852829-07:00",
        "RequiredArrivalDate": "2024-10-22T04:29:28.7852829-07:00",
        "CanShipEarly": true,
        "CanArriveEarly": true,
        "ItemWeight": "sample string 20",
        "CustomerItem": "sample string 21",
        "LotNumber": "sample string 22",
        "Length": "sample string 23",
        "Width": "sample string 24",
        "Height": "sample string 25",
        "FreightClass": "sample string 26",
        "NMFC": "sample string 27",
        "UserDefined1": "sample string 28",
        "UserDefined2": "sample string 29",
        "UserDefined3": "sample string 30",
        "TechnicalName": "sample string 31"
      },
      {
        "Country": "sample string 1",
        "HTSCode": "sample string 2",
        "Description": "sample string 3",
        "Number": "sample string 4",
        "PackageId": "sample string 5",
        "PricePerPiece": 6.0,
        "PricePerPiece2": 7.0,
        "PricePerPiece3": 8.0,
        "PricePerPiece4": 9.0,
        "Quantity": 10,
        "Quantity2": 11,
        "Quantity3": 12,
        "Quantity4": 13,
        "Unit": "sample string 14",
        "OrderNumber": "sample string 15",
        "LineType": "sample string 16",
        "LineNumber": "sample string 17",
        "RequiredShipDate": "2024-10-22T04:29:28.7852829-07:00",
        "RequiredArrivalDate": "2024-10-22T04:29:28.7852829-07:00",
        "CanShipEarly": true,
        "CanArriveEarly": true,
        "ItemWeight": "sample string 20",
        "CustomerItem": "sample string 21",
        "LotNumber": "sample string 22",
        "Length": "sample string 23",
        "Width": "sample string 24",
        "Height": "sample string 25",
        "FreightClass": "sample string 26",
        "NMFC": "sample string 27",
        "UserDefined1": "sample string 28",
        "UserDefined2": "sample string 29",
        "UserDefined3": "sample string 30",
        "TechnicalName": "sample string 31"
      }
    ],
    "ITN": "sample string 8",
    "Carrier": {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "Service": {
        "Id": 1,
        "Name": "sample string 2"
      }
    },
    "PaymentTerm": 1,
    "ThirdPartyAccountInfo": {
      "AccountNumber": "sample string 1",
      "Address": "sample string 2",
      "City": "sample string 3",
      "Country": "sample string 4",
      "Email": "sample string 5",
      "Name": "sample string 6",
      "Phone": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9"
    },
    "Reference1": "sample string 9",
    "Reference2": "sample string 10",
    "Reference3": "sample string 11",
    "Reference4": "sample string 12",
    "Reference5": "sample string 13",
    "Reference6": "sample string 14",
    "AdditionalDetails": {
      "Accessorials": [
        1,
        1
      ],
      "ReturnDutiesandTaxes": true,
      "Vin": "sample string 2",
      "BuyerId": "sample string 3",
      "Year": 4,
      "StockNumber": "sample string 5",
      "Make": "sample string 6",
      "PicturesLink": "sample string 7",
      "Model": "sample string 8",
      "SalvageId": "sample string 9",
      "VehicleCondition": 0,
      "UserDefinedField1": "sample string 10",
      "UserDefinedField2": "sample string 11",
      "UserDefinedField3": "sample string 12",
      "UserDefinedField4": "sample string 13",
      "UserDefinedField5": "2024-10-22T04:29:28.7872826-07:00",
      "UserDefinedField6": "2024-10-22T04:29:28.7872826-07:00",
      "MainIncoterm": "sample string 14",
      "InvoiceComments": "sample string 15",
      "PaymentTerms": "sample string 16",
      "PackingSlipComments": "sample string 17",
      "PaymentDueDate": "2024-10-22T04:29:28.7872826-07:00",
      "Tins": "sample string 18",
      "TinsType": "sample string 19",
      "PostalCode": "sample string 20",
      "PersonName": "sample string 21",
      "CompanyName": "sample string 22",
      "PhoneNumber": "sample string 23",
      "EmailAddress": "sample string 24",
      "StreetLine1": "sample string 25",
      "StreetLine2": "sample string 26",
      "City": "sample string 27",
      "StateOrProvinceCode": "sample string 28",
      "CountryCode": "sample string 29",
      "IsBrokerSelected": true,
      "FedExBrokerType": "sample string 31",
      "ThirdPartyInsuranceAmount": 32.0,
      "ThirdPartyInsuranceCommodityCode": "sample string 33",
      "CarrierInsuranceAmount": 34.0,
      "CODDetails": {
        "Amount": 1.0,
        "ChargeCode": "sample string 2",
        "PaymentType": 1,
        "RemitAddress": {
          "AttentionTo": "sample string 1",
          "City": "sample string 2",
          "CompanyId": "sample string 3",
          "Company": "sample string 4",
          "Country": "sample string 5",
          "Email": "sample string 6",
          "State": "sample string 7",
          "Street1": "sample string 8",
          "Street2": "sample string 9",
          "Phone": "sample string 10",
          "Zip": "sample string 11",
          "OrderType": "sample string 12"
        }
      },
      "DeliveryConfirmation": 1,
      "HazmatEmergencyNo": "sample string 35",
      "HazmatContact": "sample string 36",
      "IsSaturdayDelivery": true,
      "IsDeliveryDutyPaid": true,
      "SpecialInstructions": "sample string 39",
      "PickupSpecialInstructions": "sample string 40",
      "Alcohol": true
    },
    "Documents": [
      {
        "DocumentName": "sample string 1",
        "DocumentBase64": "sample string 2",
        "DocumentType": 0,
        "IsForInternal": true,
        "IsForCustomer": true,
        "IsForVendor": true,
        "IsForBroker": true
      },
      {
        "DocumentName": "sample string 1",
        "DocumentBase64": "sample string 2",
        "DocumentType": 0,
        "IsForInternal": true,
        "IsForCustomer": true,
        "IsForVendor": true,
        "IsForBroker": true
      }
    ]
  },
  {
    "TransactionType": 0,
    "OrderType": "sample string 1",
    "AutoprocessShipment": true,
    "ShipDate": "2024-10-22T04:29:28.778282-07:00",
    "OrderNumber": "sample string 3",
    "QuoteId": "sample string 4",
    "RateId": "sample string 5",
    "CustomerId": "sample string 6",
    "CompanyErpId": 7,
    "ShipperAddress": {
      "CompanyId": "sample string 1",
      "Company": "sample string 2",
      "StoreNumber": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "OpenTime": "sample string 14",
      "CloseTime": "sample string 15",
      "UserDefined1": "sample string 16",
      "UserDefined2": "sample string 17",
      "UserDefined3": "sample string 18",
      "UserDefined4": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7792798-07:00",
      "IncludeReturnLabel": true
    },
    "ReturnAddress": {
      "CompanyId": "sample string 1",
      "Company": "sample string 2",
      "StoreNumber": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "OpenTime": "sample string 14",
      "CloseTime": "sample string 15",
      "UserDefined1": "sample string 16",
      "UserDefined2": "sample string 17",
      "UserDefined3": "sample string 18",
      "UserDefined4": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7792798-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7792798-07:00",
      "IncludeReturnLabel": true
    },
    "ConsigneeAddress": {
      "CompanyId": "sample string 1",
      "StoreNumber": "sample string 2",
      "TaxIdNumber": "sample string 3",
      "Company": "sample string 4",
      "AttentionTo": "sample string 5",
      "Street1": "sample string 6",
      "Street2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zip": "sample string 10",
      "Country": "sample string 11",
      "Phone": "sample string 12",
      "Email": "sample string 13",
      "CarrierInsuranceAmount": "sample string 14",
      "RequiredArrivalDate": "2024-10-22T04:29:28.7792798-07:00",
      "RequiredShipDate": "2024-10-22T04:29:28.7802792-07:00",
      "OpenTime": "sample string 17",
      "CloseTime": "sample string 18",
      "UserDefined1": "sample string 19",
      "UserDefined2": "sample string 20",
      "UserDefined3": "sample string 21",
      "UserDefined4": "2024-10-22T04:29:28.7802792-07:00",
      "UserDefined5": "2024-10-22T04:29:28.7802792-07:00",
      "UserDefined6": "2024-10-22T04:29:28.7802792-07:00",
      "CanArriveEarly": true,
      "CanShipEarly": true,
      "AllowConsolidations": true
    },
    "SoldToAddress": {
      "CompanyId": "sample string 1",
      "StoreNumber": "sample string 2",
      "Company": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Email": "sample string 12",
      "TaxIdNumber": "sample string 13",
      "UserDefined1": "sample string 14",
      "UserDefined2": "sample string 15",
      "UserDefined3": "sample string 16",
      "UserDefined4": "2024-10-22T04:29:28.781277-07:00",
      "UserDefined5": "2024-10-22T04:29:28.781277-07:00",
      "UserDefined6": "2024-10-22T04:29:28.781277-07:00"
    },
    "Items": [
      {
        "Unit": 1,
        "PackageId": "sample string 1",
        "Quantity": 2,
        "PackageType": 1,
        "Length": 3.1,
        "Width": 4.1,
        "Height": 5.1,
        "Weight": 6.1,
        "FreightClass": 7.1,
        "Description": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1,
        "InnerPieces": [
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          },
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          }
        ]
      },
      {
        "Unit": 1,
        "PackageId": "sample string 1",
        "Quantity": 2,
        "PackageType": 1,
        "Length": 3.1,
        "Width": 4.1,
        "Height": 5.1,
        "Weight": 6.1,
        "FreightClass": 7.1,
        "Description": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1,
        "InnerPieces": [
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          },
          {
            "Unit": 1,
            "PackageType": 1,
            "Quantity": 1,
            "ItemNumber": "sample string 2",
            "Length": 3.1,
            "Width": 4.1,
            "Height": 5.1,
            "Weight": 6.1,
            "Description": "sample string 7",
            "FreightClass": "sample string 8",
            "NMFC": "sample string 9",
            "Hazmat": true,
            "UnNumber": "sample string 11",
            "TechnicalName": "sample string 12"
          }
        ]
      }
    ],
    "ProductDetails": [
      {
        "Country": "sample string 1",
        "HTSCode": "sample string 2",
        "Description": "sample string 3",
        "Number": "sample string 4",
        "PackageId": "sample string 5",
        "PricePerPiece": 6.0,
        "PricePerPiece2": 7.0,
        "PricePerPiece3": 8.0,
        "PricePerPiece4": 9.0,
        "Quantity": 10,
        "Quantity2": 11,
        "Quantity3": 12,
        "Quantity4": 13,
        "Unit": "sample string 14",
        "OrderNumber": "sample string 15",
        "LineType": "sample string 16",
        "LineNumber": "sample string 17",
        "RequiredShipDate": "2024-10-22T04:29:28.7852829-07:00",
        "RequiredArrivalDate": "2024-10-22T04:29:28.7852829-07:00",
        "CanShipEarly": true,
        "CanArriveEarly": true,
        "ItemWeight": "sample string 20",
        "CustomerItem": "sample string 21",
        "LotNumber": "sample string 22",
        "Length": "sample string 23",
        "Width": "sample string 24",
        "Height": "sample string 25",
        "FreightClass": "sample string 26",
        "NMFC": "sample string 27",
        "UserDefined1": "sample string 28",
        "UserDefined2": "sample string 29",
        "UserDefined3": "sample string 30",
        "TechnicalName": "sample string 31"
      },
      {
        "Country": "sample string 1",
        "HTSCode": "sample string 2",
        "Description": "sample string 3",
        "Number": "sample string 4",
        "PackageId": "sample string 5",
        "PricePerPiece": 6.0,
        "PricePerPiece2": 7.0,
        "PricePerPiece3": 8.0,
        "PricePerPiece4": 9.0,
        "Quantity": 10,
        "Quantity2": 11,
        "Quantity3": 12,
        "Quantity4": 13,
        "Unit": "sample string 14",
        "OrderNumber": "sample string 15",
        "LineType": "sample string 16",
        "LineNumber": "sample string 17",
        "RequiredShipDate": "2024-10-22T04:29:28.7852829-07:00",
        "RequiredArrivalDate": "2024-10-22T04:29:28.7852829-07:00",
        "CanShipEarly": true,
        "CanArriveEarly": true,
        "ItemWeight": "sample string 20",
        "CustomerItem": "sample string 21",
        "LotNumber": "sample string 22",
        "Length": "sample string 23",
        "Width": "sample string 24",
        "Height": "sample string 25",
        "FreightClass": "sample string 26",
        "NMFC": "sample string 27",
        "UserDefined1": "sample string 28",
        "UserDefined2": "sample string 29",
        "UserDefined3": "sample string 30",
        "TechnicalName": "sample string 31"
      }
    ],
    "ITN": "sample string 8",
    "Carrier": {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "Service": {
        "Id": 1,
        "Name": "sample string 2"
      }
    },
    "PaymentTerm": 1,
    "ThirdPartyAccountInfo": {
      "AccountNumber": "sample string 1",
      "Address": "sample string 2",
      "City": "sample string 3",
      "Country": "sample string 4",
      "Email": "sample string 5",
      "Name": "sample string 6",
      "Phone": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9"
    },
    "Reference1": "sample string 9",
    "Reference2": "sample string 10",
    "Reference3": "sample string 11",
    "Reference4": "sample string 12",
    "Reference5": "sample string 13",
    "Reference6": "sample string 14",
    "AdditionalDetails": {
      "Accessorials": [
        1,
        1
      ],
      "ReturnDutiesandTaxes": true,
      "Vin": "sample string 2",
      "BuyerId": "sample string 3",
      "Year": 4,
      "StockNumber": "sample string 5",
      "Make": "sample string 6",
      "PicturesLink": "sample string 7",
      "Model": "sample string 8",
      "SalvageId": "sample string 9",
      "VehicleCondition": 0,
      "UserDefinedField1": "sample string 10",
      "UserDefinedField2": "sample string 11",
      "UserDefinedField3": "sample string 12",
      "UserDefinedField4": "sample string 13",
      "UserDefinedField5": "2024-10-22T04:29:28.7872826-07:00",
      "UserDefinedField6": "2024-10-22T04:29:28.7872826-07:00",
      "MainIncoterm": "sample string 14",
      "InvoiceComments": "sample string 15",
      "PaymentTerms": "sample string 16",
      "PackingSlipComments": "sample string 17",
      "PaymentDueDate": "2024-10-22T04:29:28.7872826-07:00",
      "Tins": "sample string 18",
      "TinsType": "sample string 19",
      "PostalCode": "sample string 20",
      "PersonName": "sample string 21",
      "CompanyName": "sample string 22",
      "PhoneNumber": "sample string 23",
      "EmailAddress": "sample string 24",
      "StreetLine1": "sample string 25",
      "StreetLine2": "sample string 26",
      "City": "sample string 27",
      "StateOrProvinceCode": "sample string 28",
      "CountryCode": "sample string 29",
      "IsBrokerSelected": true,
      "FedExBrokerType": "sample string 31",
      "ThirdPartyInsuranceAmount": 32.0,
      "ThirdPartyInsuranceCommodityCode": "sample string 33",
      "CarrierInsuranceAmount": 34.0,
      "CODDetails": {
        "Amount": 1.0,
        "ChargeCode": "sample string 2",
        "PaymentType": 1,
        "RemitAddress": {
          "AttentionTo": "sample string 1",
          "City": "sample string 2",
          "CompanyId": "sample string 3",
          "Company": "sample string 4",
          "Country": "sample string 5",
          "Email": "sample string 6",
          "State": "sample string 7",
          "Street1": "sample string 8",
          "Street2": "sample string 9",
          "Phone": "sample string 10",
          "Zip": "sample string 11",
          "OrderType": "sample string 12"
        }
      },
      "DeliveryConfirmation": 1,
      "HazmatEmergencyNo": "sample string 35",
      "HazmatContact": "sample string 36",
      "IsSaturdayDelivery": true,
      "IsDeliveryDutyPaid": true,
      "SpecialInstructions": "sample string 39",
      "PickupSpecialInstructions": "sample string 40",
      "Alcohol": true
    },
    "Documents": [
      {
        "DocumentName": "sample string 1",
        "DocumentBase64": "sample string 2",
        "DocumentType": 0,
        "IsForInternal": true,
        "IsForCustomer": true,
        "IsForVendor": true,
        "IsForBroker": true
      },
      {
        "DocumentName": "sample string 1",
        "DocumentBase64": "sample string 2",
        "DocumentType": 0,
        "IsForInternal": true,
        "IsForCustomer": true,
        "IsForVendor": true,
        "IsForBroker": true
      }
    ]
  }
]

Response Information

Resource Description

BadResponse
NameDescriptionTypeAdditional information
Data

Data returned by api

Object

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Code": 100,
  "Message": "sample string 2",
  "Data": {}
}