ProcessedOrders

GetOrderInfo

Use this call to retrieve detailed information about a processed order (header level). <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>250</b></span> / minute

get/api/ProcessedOrders/GetOrderInfo

Request

  • Base URL
    https://eu-ext.linnworks.net
  • URL
    https://eu-ext.linnworks.net/api/ProcessedOrders/GetOrderInfo
  • Auth
    API key in header Authorization

Query parameters

pkOrderIdstring uuid

The id of the order.

Response

OK

pkOrderIDstring uuid

Order ID

cShippingAddressstring

Customer's shipping address

dReceivedDatestring date-time

Date when order was received on a channel

dProcessedOnstring date-time

Date when order was processed

timeDiffnumber double

Days elapsed between order received and order processed

fPostageCostnumber double

Order postage cost

fTotalChargenumber double

Order total charge

PostageCostExTaxnumber double

Postage cost excluding tax

Subtotalnumber double

Order subtotal

fTaxnumber double

Order tax

TotalDiscountnumber double

Total discount

ProfitMarginnumber double

Profit margin

CountryTaxRatenumber double

Country specific tax rate

nOrderIdinteger

Linnworks order ID

nStatusinteger

Order status

cCurrencystring

Order currency

PostalTrackingNumberstring

Postal tracking number

cCountrystring

Country

Sourcestring

ChannelName/Source (e.g. EBAY)

PostalServiceNamestring

Postal service name (e.g. Next day delivery)

PostalServiceCodestring

Postal service code

Vendorstring

Courier name (e.g. DPD)

BillingEmailAddressstring
ReferenceNumstring

Order reference number

SecondaryReferencestring

An additional reference number for the order

ExternalReferencestring

This is an additional reference number from the sales channel, typically used by eBay

Address1string

Order first line of address

Address2string

Order second line of address

Address3string

Order third line of address

Townstring

Town

Regionstring

Region, county, area

BuyerPhoneNumberstring

Buyer phone number

Companystring

Company

SubSourcestring

Order subsource (e.g. EBAY1)

ChannelBuyerNamestring

Channel specific name used to identify the buyer, such as a username, normally used for eBay

AccountNamestring

Customer channel account name

cFullNamestring

Customer full name

cEmailAddressstring

Customer email address

cPostCodestring

Post Code

dPaidOnstring date-time

When order was marked as PAID

dCancelledOnstring date-time

When order was cancelled

PackageCategorystring

Package category

PackageTitlestring

Package name

ItemWeightnumber double

Items weight

TotalWeightnumber double

Total order weight

FolderCollectionstring

Folder name of an order

cBillingAddressstring

Customer billing address

BillingNamestring

Customer billing name

BillingCompanystring

Customer billing company

BillingAddress1string

Billing address line one

BillingAddress2string

Billing address line two

BillingAddress3string

Billing address line three

BillingTownstring

Billing town

BillingRegionstring

Billing region, area, county

BillingPostCodestring

Billing postcode

BillingCountryNamestring

Billing country

BillingPhoneNumberstring

Billing phone number

HoldOrCancelboolean

If order on hold or cancelled.

IsResendboolean

If order was created from a resend

IsExchangeboolean

If order was created from an exchange

TaxIdstring

Order tax id

FulfilmentLocationNamestring

Order fulfilment location

Example response

{
  "pkOrderID": "00000000-0000-0000-0000-000000000000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.