Skip to main content

Update surcharge

PATCH 
/v1/surcharges/:id

Update surcharge

Request​

Path Parameters

    id uuidrequired

    Surcharge id

    Example: 123e4567-e89b-12d3-a456-426614174000

Body

required

Update surcharge input

    name

    object[]

    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 string

    Possible values: [flat_fee, percentage]

    Type of the surcharge

    value number

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

    taxCode string

    Possible values: [H, L, N]

    Tax code

    taxZone string

    Possible values: >= 2 characters and <= 2 characters

    Tax zone

    enabled boolean

    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

    shopId integer

    Shop identifier for the surcharge to apply to... If not provided the default will be inferred from the channel

Responses​

Surcharge updated

Schema

    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

Loading...