POST order/importOrder/v3

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/v3

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

Request Information

URI Parameters

None.

Body Parameters

Collection of OrderV3dto
NameDescriptionTypeAdditional information
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.

Carrier

Provide carrier details to make shipment from that carrier.

CarrierV2

None.

Items

Shipment Items

Collection of ShipmentItemV2dto

None.

PaymentTerm

Order payment terms

PaymentTerm

None.

ThirdPartyAccountInfo

Third party account details

AccountDetails

None.

ShipDate

Ship date in UTC

date

None.

ShipperAddress

Shipper address

OrderShipperAddressV3

None.

ReturnAddress

Return Address

Address

None.

IncludeReturnLabel

Include parcel return label

boolean

None.

ConsigneeAddress

Consignee address

OrderConsigineeAddressV3

None.

Reference1

Reference 1

string

None.

Reference2

Referece 2

string

None.

Reference3

Reference 3

string

None.

Reference4

Reference 4

string

None.

Reference5

Reference 5

string

None.

Reference6

Reference 6

string

None.

ProductDetails

Product details

Collection of ProductDetailV3

None.

ITN

International transaction number

string

None.

AdditionalDetails

Additional details

AdditionalDetailsV3
Optional
OrderType

Type of the order i.e Sales Order, Invoice etc

string

None.

AutoprocessShipment

Auto process Shipment of the order

boolean
Optional(Default value is false)
TransactionType

Type of the transaction i-e Sales or Purchasing

OrderTransactionType
Optional(Default transaction type is Sales)
Documents

Documents for the order

Collection of OrderDocumentDto
Optional(Documents for the order)
CompanyErpId

Company ERP Id

integer
Optional

Request Formats

application/json, text/json

Sample:
[
  {
    "OrderNumber": "sample string 1",
    "QuoteId": "sample string 2",
    "RateId": "sample string 3",
    "CustomerId": "sample string 4",
    "Carrier": {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "Service": {
        "Id": 1,
        "Name": "sample string 2"
      }
    },
    "Items": [
      {
        "InnerPieces": {
          "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",
          "Unit": 1
        },
        "Description": "sample string 1",
        "FreightClass": 2.1,
        "Height": 3.1,
        "Length": 4.1,
        "PackageType": 1,
        "Quantity": 5,
        "Weight": 6.1,
        "Unit": 1,
        "Width": 7.1,
        "PackageId": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1
      },
      {
        "InnerPieces": {
          "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",
          "Unit": 1
        },
        "Description": "sample string 1",
        "FreightClass": 2.1,
        "Height": 3.1,
        "Length": 4.1,
        "PackageType": 1,
        "Quantity": 5,
        "Weight": 6.1,
        "Unit": 1,
        "Width": 7.1,
        "PackageId": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1
      }
    ],
    "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"
    },
    "ShipDate": "2024-05-17T19:50:36.9711584-07:00",
    "ShipperAddress": {
      "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"
    },
    "ReturnAddress": {
      "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"
    },
    "IncludeReturnLabel": true,
    "ConsigneeAddress": {
      "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",
      "RequiredArrivalDate": "2024-05-17T19:50:36.9711584-07:00",
      "RequiredShipDate": "2024-05-17T19:50:36.9711584-07:00",
      "CanArriveEarly": true,
      "CanShipEarly": true,
      "AllowConsolidations": true
    },
    "Reference1": "sample string 6",
    "Reference2": "sample string 7",
    "Reference3": "sample string 8",
    "Reference4": "sample string 9",
    "Reference5": "sample string 10",
    "Reference6": "sample string 11",
    "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-05-17T19:50:36.9721561-07:00",
        "RequiredArrivalDate": "2024-05-17T19:50:36.9721561-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"
      },
      {
        "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-05-17T19:50:36.9721561-07:00",
        "RequiredArrivalDate": "2024-05-17T19:50:36.9721561-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"
      }
    ],
    "ITN": "sample string 12",
    "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-05-17T19:50:36.9731548-07:00",
      "UserDefinedField6": "2024-05-17T19:50:36.9731548-07:00",
      "MainIncoterm": "sample string 14",
      "InvoiceComments": "sample string 15",
      "PaymentTerms": "sample string 16",
      "PackingSlipComments": "sample string 17",
      "PaymentDueDate": "2024-05-17T19:50:36.9731548-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
    },
    "OrderType": "sample string 13",
    "AutoprocessShipment": true,
    "TransactionType": 0,
    "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
      }
    ],
    "CompanyErpId": 15
  },
  {
    "OrderNumber": "sample string 1",
    "QuoteId": "sample string 2",
    "RateId": "sample string 3",
    "CustomerId": "sample string 4",
    "Carrier": {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "Service": {
        "Id": 1,
        "Name": "sample string 2"
      }
    },
    "Items": [
      {
        "InnerPieces": {
          "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",
          "Unit": 1
        },
        "Description": "sample string 1",
        "FreightClass": 2.1,
        "Height": 3.1,
        "Length": 4.1,
        "PackageType": 1,
        "Quantity": 5,
        "Weight": 6.1,
        "Unit": 1,
        "Width": 7.1,
        "PackageId": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1
      },
      {
        "InnerPieces": {
          "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",
          "Unit": 1
        },
        "Description": "sample string 1",
        "FreightClass": 2.1,
        "Height": 3.1,
        "Length": 4.1,
        "PackageType": 1,
        "Quantity": 5,
        "Weight": 6.1,
        "Unit": 1,
        "Width": 7.1,
        "PackageId": "sample string 8",
        "Hazmat": true,
        "FPHazmatId": 1
      }
    ],
    "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"
    },
    "ShipDate": "2024-05-17T19:50:36.9711584-07:00",
    "ShipperAddress": {
      "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"
    },
    "ReturnAddress": {
      "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"
    },
    "IncludeReturnLabel": true,
    "ConsigneeAddress": {
      "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",
      "RequiredArrivalDate": "2024-05-17T19:50:36.9711584-07:00",
      "RequiredShipDate": "2024-05-17T19:50:36.9711584-07:00",
      "CanArriveEarly": true,
      "CanShipEarly": true,
      "AllowConsolidations": true
    },
    "Reference1": "sample string 6",
    "Reference2": "sample string 7",
    "Reference3": "sample string 8",
    "Reference4": "sample string 9",
    "Reference5": "sample string 10",
    "Reference6": "sample string 11",
    "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-05-17T19:50:36.9721561-07:00",
        "RequiredArrivalDate": "2024-05-17T19:50:36.9721561-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"
      },
      {
        "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-05-17T19:50:36.9721561-07:00",
        "RequiredArrivalDate": "2024-05-17T19:50:36.9721561-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"
      }
    ],
    "ITN": "sample string 12",
    "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-05-17T19:50:36.9731548-07:00",
      "UserDefinedField6": "2024-05-17T19:50:36.9731548-07:00",
      "MainIncoterm": "sample string 14",
      "InvoiceComments": "sample string 15",
      "PaymentTerms": "sample string 16",
      "PackingSlipComments": "sample string 17",
      "PaymentDueDate": "2024-05-17T19:50:36.9731548-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
    },
    "OrderType": "sample string 13",
    "AutoprocessShipment": true,
    "TransactionType": 0,
    "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
      }
    ],
    "CompanyErpId": 15
  }
]

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": {}
}