Skip to main content

Order by lookup key

GET 
/orders/:lookupKey/:lookupValue

Retrieve order details by a specific lookupKey / lookupId combination

lookupKeys
id
sourceId

What are lookup keys?

Request​

Path Parameters

    lookupKey stringrequired

    Use id or externalId

    id - Integer

    lookupValue stringrequired

    The id or externalId of the order

Query Parameters

    expands string

    Optional. Use orderitems to retrieve the orderitems of the order. Use orderitems.product to retrive product details for each orderitem.

Responses​

Get Order by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object

    channelId number

    clientData

    object

    object
    date string
    debtorId string
    email string
    externalId string
    extraInfo string
    firstName string
    id number

    invoiceData

    object

    address

    object

    active string
    city string
    code string
    company string
    country string
    email string
    fax string
    firstName string
    gender string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    name string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
    itemCount number

    items

    object[]

  • Array [

    • childItems undefined[]
    discountAmount number
    discountAmountNet number
    discountAmountTotal number
    discountAmountTotalNet number
    discountPercentage number
    name string
    notes string
    price number
    quantity number
    sku string
    supplier string
    supplierCode string
    taxCode string
    taxPercentage number
    type string
    unit number

  • ]

    • language string
    lastName string
    middleName string

    paymentData

    object

    grossAmount number
    netAmount number
    payMethod string
    payStatus string
    paystatusdate string
    tax number
    taxPercentage number
    transactionId string

    postageData

    object

    carrier string
    partialDeliveryAllowed string
    pickUpLocationId number
    postage number
    postageNet number
    postageTaxPercentage number
    requestDate string
    shippingMethod string
    reference string
    remarks string

    shippingData

    object

    address

    object

    active string
    city string
    code string
    company string
    country string
    email string
    fax string
    firstName string
    gender string
    icp string
    id number
    isDefault string
    lastName string
    middleName string
    mobile string
    name string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string

    shop

    object

    id number
    name string
    shopId number
    source string
    status string

    total

    object

    discountPercentage number
    discountValue number

    tax

    object

    11 number
    21 number
    totalGross number
    totalNet number
    type string
    userId number
    messages undefined[]
    total number
Loading...