Skip to main content

Get Pricesheet by lookup key

GET 

/pricesheets/:lookupKey/:lookupValue

Use this endpoint to retrieve price sheet details by lookup key. The expands parameter can be used to retrieve the pricing for the price sheet.

Request

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about price sheet lookup keys

    lookupValue stringrequired

    The value of the key (id or code)

Query Parameters

    expands string

    Optional. Use products and/ or categories to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved.

    What is resource expanding?

Responses

Get Pricesheet by code - 200 (expands products, categories) / Get Pricesheet by code - 200 (without expands)

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

    code string
    description string
    name string

    pricing

    object[]

  • Array [

  • category

    object

    descriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • id number

    names

    object[]

  • Array [

  • language string
    value string
  • ]

  • pricing

    object

    amount number
    quantity number
    type string
    validFrom string
    validTo string

    shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • product

    object

    descriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • eanCode string
    id number
    minimumQuantity number

    names

    object[]

  • Array [

  • language string
    value string
  • ]

  • notes

    object[]

  • Array [

  • language string
    value string
  • ]

  • oemCode string

    packageDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • price number

    pricing

    object

    amount number
    price number
    quantity number
    type string
    validFrom string
    validTo string

    shortDescriptions

    object[]

  • Array [

  • language string
    value string
  • ]

  • shortName string
    sku string
    status string
    supplier string
    supplierCode string
    taxCode string
    taxPercentage number
    unit number
  • ]

  • shopId number
    messages undefined[]
    total number
Loading...