Skip to main content

List surcharges for product

GET 
/v1/surcharges/product/:productId

List surcharges for product

Request​

Path Parameters

    productId integerrequired

    Product id

Query Parameters

    type string

    Possible values: [flat_fee, percentage]

    Only search for surcharges of type provided

    Example: flat_fee
    taxCode string

    Possible values: [H, L, N]

    Only search for surcharges with taxCode provided

    Example: H
    enabled any

    Only search for enabled surcharges

    Example: true
    page any

    Pagination page number

    Example: 1
    offset any

    Pagination offset number

    Example: 12

Responses​

List surcharges for product

Schema

    items

    object[]

    required

    List of items of type SurchargeProduct

  • Array [

    • surchargeId uuidrequired

    The surcharge identifier

    productId integer

    The product identifier

    surcharge

    object

    required

    id uuidrequired

    Unique identifier for the surcharge

    name

    object[]

    required

    A descriptive name for the surcharge

  • Array [

    • language stringrequired

    Localized field language code

    value stringnullablerequired

    Localized field value

  • ]

    • description

    object[]

    A brief description of the surcharge

  • Array [

    • language stringrequired

    Localized field language code

    value stringnullablerequired

    Localized field value

  • ]

    • type stringrequired

    Possible values: [flat_fee, percentage]

    Type of the surcharge

    value numberrequired

    The value to be applied as surcharge (e.g., percentage or amount)

    taxCode stringrequired

    Possible values: [flat_fee, percentage]

    Type of the surcharge

    taxZone stringrequired

    Tax zone

    enabled booleanrequired

    Indicates whether the surcharge is active or not

    validFrom date-time

    The date and time the surcharge is valid from

    validTo date-time

    The date and time the surcharge is valid to

    createdBy integer

    The userId of the user that created the surcharge

    changedBy integer

    The userId of the user that changed the surcharge

    dateCreated date-timerequired

    The date and time the surcharge is created

    dateChanged date-timerequired

    The date and time the surcharge is changed

    shopId integer

    Shop identifier for the tax to apply to

  • ]

    • itemsFound integerrequired

    Total number of items found

    offset integernullablerequired

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullablerequired

    Possible values: >= 1

    Default value: 1

    The current page

    pages integernullablerequired

    Possible values: >= 1

    Total amount of pages

    start integernullablerequired

    Possible values: >= 1

    Start position of the current page

    end integernullablerequired

    Possible values: >= 1

    End position of the current page

Loading...