Update a sponsored-products provider

Pre-launch API. The concepts described here are settled, but the API shape is not: request and response fields, parameters and defaults can still change. Build against it, and talk to your Luigi's Box contact before you put an integration into production.

PATCH

/platform/v1/sponsored-providers/{sponsored_provider_id}

const url = 'https://api.eu1.luigisbox.ai/platform/v1/sponsored-providers/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"config":{"aliases":{"additionalProperty":"example"},"area":"example","base_url":"example","change_item_url":false,"domain":"example","platform":"cruxo","position_path":"example","product_id_path":"example","service_path":"example","size":"example","test":1,"use_page":true},"credentials":{"additionalProperty":"example"},"name":"example","status":"active"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.eu1.luigisbox.ai/platform/v1/sponsored-providers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "aliases": { "additionalProperty": "example" }, "area": "example", "base_url": "example", "change_item_url": false, "domain": "example", "platform": "cruxo", "position_path": "example", "product_id_path": "example", "service_path": "example", "size": "example", "test": 1, "use_page": true }, "credentials": { "additionalProperty": "example" }, "name": "example", "status": "active" }'

Authorizations

HTTPBearer

Parameters

Path Parameters

sponsored_provider_id

required

Sponsored Provider Id

string

Request Body^required

application/json

SponsoredProviderUpdate

Partial update (JSON Merge Patch). Only present fields are applied.

organization_id is immutable — a different organization is a different account — so it is not accepted: sending it, or any field not listed here, is rejected with 422. The platform is immutable too: it lives inside config and a present config must re-state platform, so changing it is a different account. A present config or credentials replaces that map as a whole ({} clears the credentials), and each is validated as one unit.

object

config

One of: discriminator: platform

CruxoProviderConfig

CruxoProviderConfig

The connection-level half of a cruxo config — everything tied to the account itself.

None of it varies by channel or surface. An account needing both a search and a product variant is two providers.

object

aliases

Aliases

object

key

additional properties

string

area

required

Area

string

>= 1 characters

base_url

required

Base Url

string

>= 1 characters

change_item_url

Change Item Url

boolean

domain

required

Domain

string

>= 1 characters

platform

required

Platform

string

Allowed value: cruxo

position_path

Any of:

string
null

string

product_id_path

required

Product Id Path

string

>= 1 characters

service_path

required

Service Path

string

>= 1 characters

size

required

Size

string

>= 1 characters

test

Any of:

integer
null

integer

use_page

Use Page

boolean

default: true

credentials

Credentials

object

key

additional properties

string

name

Name

string

>= 1 characters <= 256 characters

status

SponsoredStatus

Lifecycle state of a sponsored-products provider or placement.

Only an active one serves sponsored objects. A disabled one stops serving shortly after the change and stays editable over the API.

string

Allowed values: active disabled

Responses

200

Successful Response

application/json

SponsoredProvider

Provider response. credentials is write-only and surfaces only as credentials_set.

The platform is reported inside config (the platform discriminator), not as a separate top-level field.

object

config

required

One of: discriminator: platform

CruxoProviderConfig

CruxoProviderConfig

The connection-level half of a cruxo config — everything tied to the account itself.

None of it varies by channel or surface. An account needing both a search and a product variant is two providers.

object

aliases

Aliases

object

key

additional properties

string

area

required

Area

string

>= 1 characters

base_url

required

Base Url

string

>= 1 characters

change_item_url

Change Item Url

boolean

domain

required

Domain

string

>= 1 characters

platform

required

Platform

string

Allowed value: cruxo

position_path

Any of:

string
null

string

product_id_path

required

Product Id Path

string

>= 1 characters

service_path

required

Service Path

string

>= 1 characters

size

required

Size

string

>= 1 characters

test

Any of:

integer
null

integer

use_page

Use Page

boolean

default: true

created_at

required

Created At

string format: date-time

created_by

required

Any of:

string
null

string

credentials_set

required

Credentials Set

boolean

required

string

name

required

Name

string

organization_id

required

Organization Id

string

status

required

SponsoredStatus

Lifecycle state of a sponsored-products provider or placement.

Only an active one serves sponsored objects. A disabled one stops serving shortly after the change and stays editable over the API.

string

Allowed values: active disabled

updated_at

required

Updated At

string format: date-time

updated_by

required

Any of:

string
null

string

Example

{
  "config": {
    "change_item_url": false,
    "platform": "cruxo",
    "use_page": true
  },
  "status": "active"
}

400

Malformed request

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

401

Missing or invalid credentials

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

403

Authenticated but not permitted

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

404

Resource not found

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

409

State conflict

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

422

Request validation failed

application/json

ErrorResponse

Canonical error body — every non-2xx response uses this shape.

object

exception_details

ExceptionDetails

Machine-readable error context; empty object when there is nothing to add.

object

validation_errors

Any of:

Array<object>
null

Array<object>

ValidationProblem

One field-level reason a request was rejected.

object

loc

required

Loc

Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

Array

msg

required

Msg

What is wrong with the value at loc.

string

type

required

Type

Stable machine code for the problem, e.g. missing or string_too_short.

string

key

additional properties

any

reason

required

Reason

Human-readable, actionable error message.

string

request_id

Any of:

string
null

string

Example ^generated

{
  "exception_details": {
    "validation_errors": [
      {
        "loc": [
          "example"
        ],
        "msg": "example",
        "type": "example"
      }
    ]
  },
  "reason": "example",
  "request_id": "example"
}

Was this page helpful?

Thanks.

Update a sponsored-products provider

Authorizations

Parameters

Path Parameters

Request Body required

Responses

200

Example

400

Example generated

401

Example generated

403

Example generated

404

Example generated

409

Example generated

422

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated