Skip to main content

Assign companies to an orderlist

PATCH 
/v2/orderlists/:id/assign-companies

Assign companies to an orderlist

Request​

Path Parameters

    id integerrequired

    Orderlist identifier

    Example: 424242

Body

required

Companies input

    companyIds array[]nullable

    Default value: ``

    List of company ids

    companySources

    object[]

    nullable

    List of company sources

  • Array [

    • id stringrequired

    Source ID

    name stringrequired

    Name of the source

  • ]

Responses​

Companies assigned to orderlist

Schema

    id integerrequired

    Orderlist primary identifier

    createdAt date-timerequired

    Orderlist creation date

    lastModifiedAt date-timerequired

    Orderlist last modified date

    descriptions

    object[]

    required

    Orderlist description per language

  • Array [

    • language stringrequired

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

    Language is set as 2 character country code.

    value string

    Localized field value

  • ]

    • extras

    object[]

    Extra field per language

  • Array [

    • language stringrequired

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

    Language is set as 2 character country code.

    value string

    Localized field value

  • ]

    • code string

    Orderlist code

    validFrom date-time

    Valid from (Display only)

    validTo date-time

    Valid to (Display only)

    type stringrequired

    Possible values: [POSITIVE, NEGATIVE]

    Orderlist type

    partnerEntity string

    Partner entity

    active stringrequired

    Default value: Y

    Shows if the orderlist is active

    productIds array[]required

    List of product ids

    clusterIds array[]required

    List of cluster ids

    userIds array[]required

    List of user ids

    companyIds array[]required

    List of company ids

Loading...