Endpoint - Quote

Endpoint which should return the available quotes for an order.

Request

Post

QuoteRequest

Field Name	Type	Description
AuthorizationToken	Guid	Authorization token uniquely identifying each integration profile
Name	String	Customer name
CompanyName	String	Company name
AddressLine1	String	Address Line 1
AddressLine2	String	Address Line 2
AddressLine3	String	Address Line 3
Town	String	Address Town / City
Region	String	Address State / County / Region
CountryCode	String	Country code ISO 3166-2
Postalcode	String	Postal code / Zip code
Email	String	Email address of the customer
Phone	String	Phone number of the customer
Packages	Package[]	List of package class. See Endpoint - Quote - Package
OrderReference	String	Linnworks order reference number
OrderCurrency	String	Currency code (3 characters)
OrderValue	Decimal	Order value
OrderExtendedProperties	OrderExtendedProperties[]	List of extended properties items mapped to order extended properties. See Endpoint - Quote - OrderExtendedProperties

Package

Field Name	Type	Description
SequenceNumber	Integer	Sequence number of a package
PackageWeight	Decimal	Package weight (grams)
PackageWidth	Decimal	Package width (cm)
PackageHeight	Decimal	Package height (cm)
PackageDepth	Decimal	Package depth (cm)
PackageFormat	String	Packaging type: BOX PARCEL PACKET LETTER
Items	Item[]	Property title. See Endpoint - Quote - Item

Item

Field Name	Type	Description
ItemName	String	Name of the product
ProductCode	String	SKU
Quantity	Integer	Item quantity
UnitValue	Decimal	Product unit cost (OrderCurrency)
UnitWeight	Decimal	Product unit weight (gram)
Height	Decimal	Product height (cm)
Width	Decimal	Product width (cm)
Length	Decimal	Product length (cm)
ExtendedProperties	ExtendedProperty[]	Extended property as mapped to Linnworks item extended property. See Endpoint - Quote - ExtendedProperty

Extended Property

Field Name	Type	Description
Name	String	Extended Property name as defined
Value	String	Linnworks item extended property value

OrderExtendedProperties

Field Name	Type	Description
Name	String	Extended Property name as defined
Value	String	Linnworks order extended property value

Sample

Sample Request

{
  "AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb",
  "Name": "Customer name",
  "CompanyName": "Company name",
  "AddressLine1": "Great Russell St",
  "AddressLine2": "Bloomsbury",
  "AddressLine3": "",
  "Town": "London",
  "Region": "Greater London",
  "CountryCode": "GB",
  "Postalcode": "WC1B 3DG",
  "DeliveryNote": "Some note",
  "Email": "[email protected]",
  "Phone": "[phone]",
  "Packages": [
    {
      "SequenceNumber": 0,
      "Items": [
        {
          "ExtendedProperties": [
            {
              "Name": "ExtendedCover",
              "Value": "True"
            }
          ],
          "ItemName": "Product 1",
          "ProductCode": "SKU001",
          "Quantity": 1,
          "UnitValue": 1,
          "UnitWeight": 1,
          "Height": 1,
          "Width": 1,
          "Length": 1
        }
      ],
      "PackageWeight": 1,
      "PackageWidth": 1,
      "PackageHeight": 1,
      "PackageDepth": 1,
      "PackageFormat": "BOX"
    }
  ],
  "OrderReference": "ORDERREFERENCE",
  "OrderCurrency": "GBP",
  "OrderValue": 1,
  "OrderExtendedProperties": [
    {
      "Name": "SafePlace",
      "Value": "Some message"
    }
  ]
}

Response

QuoteResponse

Field Name	Type	Description
QuoteItems	QuoteItem[]	List of Quote Item class. See Endpoint - Quote - QuoteItem
IsError	Boolean	Indicates if there is an error
ErrorMessage	String / null	Error message

QuoteItem

Field Name	Type	Description
ServiceName	String	Service name as appears to the user
ServiceCode	String	Service code
ServiceId	Guid	Service Id defined in UserAvailableServices
ServiceTag	String	Service Tag
CollectionDate	DateTime	Date on which the parcel will be sent / collected
EstimatedDeliveryDate	DateTime	Estimated delivery date
Cost	Decimal	Cost of the service
Tax	Decimal	Service tax
TotalCost	Decimal	Total cost of the delivery
Currency	String	Currency code (3 chars)
PropertyItem	QuoteProperty[]	List of Quote Property class. See Endpoint - Quote - QuoteProperty
Options	QuoteServiceOption[]	List of Quote Service Option class. See Endpoint - Quote - QuoteServiceOption

QuoteProperty

Field Name	Type	Description
Title	String	Property title
Value	String	Property value

QuoteServiceOption

Field Name	Type	Description
OptionName	String	Option name
OptionValue	String	Option value

Sample Response

{
  "QuoteItems": [
    {
      "ServiceName": "Fast2Door Next Day",
      "ServiceCode": "CODE1",
      "ServiceId": "6a47631504db4d25a25ce6917a1bcad9",
      "ServiceTag": "SOMETAG",
      "CollectionDate": "/Date(1565283600000)/",
      "EstimatedDeliveryDate": "/Date(1565370000000)/",
      "Cost": 1,
      "Tax": 1,
      "TotalCost": 2,
      "Currency": "GBP",
      "PropertyItem": [
        {
          "Title": "PropertyName",
          "Value": "PropertyValue123"
        }
      ],
      "Options": [
        {
          "OptionName": "OptionName",
          "OptionValue": "OptionValue123"
        }
      ]
    }
  ],
  "IsError": false,
  "ErrorMessage": null
}