Skip to main content
API docs by Redocly

BLANC* (1.0.0)

Authentication

Login

Returns the token used to authentication.

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
email
required
email

The user email.

password
required
string

The user password.

seller
integer

The seller associated to user.

Responses

Request samples

Content type
application/json
{
  • "email": "tess.harris@example.com",
  • "password": "i4iQ_Azn(}^",
  • "seller": 11
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sellers associated to user

List the sellers associated with the logged in user. It can be used as reference to create a new token.

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Listing endpoints

List available sizes

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List available colors

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List available textures

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

List available price lists

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List available currencies

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List available segments

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List available categories

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List available collections

Authorizations:
default
header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Products management

List products for the given collection

Authorizations:
default
path Parameters
collection_id
required
integer
Example: 3

The ID of the collection.

query Parameters
filter.id
integer
Example:

An integer to filter by order id.

filter.id_operator
string
Example:

The operator used for "id" filtering. May be one of gt, gte, lt, lte. Default value is equal.

filter.date
string
Example:

An date to filter by order created.

filter.date_operator
string
Example:

The operator used for "date" filtering. May be one of gt, gte, lt, lte. Default value is equal.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Create a new product for the given collection

Authorizations:
default
path Parameters
collection_id
required
integer
Example: 3

The ID of the collection.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
required
name
required
string

Must not be greater than 255 characters.

description
string
is_active
boolean
reference_code
required
string

Must not be greater than 255 characters.

internal_name
required
string

Must not be greater than 255 characters.

wholesale_price
required
number

Must be at least 0.

retailer_price
required
number

Must be at least 0.

wholesale_price_currency
required
string

Must be one of AUD, BRL, GBP, EUR, or USD.

retailer_price_currency
required
string

Must be one of AUD, BRL, GBP, EUR, or USD.

order_minimum_quantity
integer

Must be at least 0.

order_maximum_quantity
integer

Must be at least 0.

order_delivery_days
integer

Must be at least 0.

unit_weight
number

Must be at least 0.

collection_order
required
integer

Must be at least 0.

composition
string
segments
Array of strings

Must be one of the segments returned from "/v1/sellers-api/segments". Must be one of .

categories
Array of strings

Must be one of the categories returned from "/v1/sellers-api/categories". Must be one of .

sizes
Array of strings

Must be one of the sizes returned from "/v1/sellers-api/sizes". Must be one of .

Array of objects
Array of objects
Array of objects

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show product details

Authorizations:
default
path Parameters
id
required
integer
Example: 3

The ID of the product.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update product data

Authorizations:
default
path Parameters
id
required
integer
Example: 3

The ID of the product.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
required
name
required
string

Must not be greater than 255 characters.

description
string
is_active
boolean
reference_code
required
string

Must not be greater than 255 characters.

internal_name
required
string

Must not be greater than 255 characters.

wholesale_price
required
number

Must be at least 0.

retailer_price
required
number

Must be at least 0.

wholesale_price_currency
required
string

Must be one of AUD, BRL, GBP, EUR, or USD.

retailer_price_currency
required
string

Must be one of AUD, BRL, GBP, EUR, or USD.

order_minimum_quantity
integer

Must be at least 0.

order_maximum_quantity
integer

Must be at least 0.

order_delivery_days
integer

Must be at least 0.

unit_weight
number

Must be at least 0.

collection_order
required
integer

Must be at least 0.

composition
string
segments
Array of strings

Must be one of the segments returned from "/v1/sellers-api/segments". Must be one of .

categories
Array of strings

Must be one of the categories returned from "/v1/sellers-api/categories". Must be one of .

sizes
Array of strings

Must be one of the sizes returned from "/v1/sellers-api/sizes". Must be one of .

Array of objects
Array of objects
Array of objects

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete product

Authorizations:
default
path Parameters
id
required
integer
Example: 3

The ID of the product.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Remove a pricelist from a product

Authorizations:
default
path Parameters
product
required
integer

The ID of the product.

pricelist
required
integer

The ID of the pricelist.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Delete a product detail

Authorizations:
default
path Parameters
detail
required
integer

The ID of the product detail.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Delete a product variation

Authorizations:
default
path Parameters
variation
required
integer

The ID of the product variation.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Remove a size from a product variation

Authorizations:
default
path Parameters
variation
required
integer

The ID of the product variation.

size
required
integer

The ID of the size.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Create a new stock for the given product variation

Authorizations:
default
path Parameters
variation_id
required
integer

The ID of the product variation.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
size_id
required
integer

Must be one of the sizes returned from "/v1/sellers-api/products/{product}" response. Must be one of .

order_minimum_quantity
integer

Must be at least 0.

order_maximum_quantity
integer

Must be at least 0.

qtty_stock
required
integer

Must be at least 0.

sku
required
string

Should be unique. Must not be greater than 30 characters.

Responses

Request samples

Content type
application/json
{
  • "size_id": null,
  • "order_minimum_quantity": 86,
  • "order_maximum_quantity": 16,
  • "qtty_stock": 54,
  • "sku": "foiinanfg"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update stock data

Authorizations:
default
path Parameters
id
required
integer

The ID of the stock.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
size_id
required
integer

Must be one of the sizes returned from "/v1/sellers-api/products/{product}" response. Must be one of .

order_minimum_quantity
integer

Must be at least 0.

order_maximum_quantity
integer

Must be at least 0.

qtty_stock
required
integer

Must be at least 0.

sku
required
string

Should be unique. Must not be greater than 30 characters.

Responses

Request samples

Content type
application/json
{
  • "size_id": null,
  • "order_minimum_quantity": 27,
  • "order_maximum_quantity": 72,
  • "qtty_stock": 27,
  • "sku": "xueg"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a product variation picture

Authorizations:
default
path Parameters
picture
required
integer

The ID of the picture.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Orders management

List orders

Authorizations:
default
query Parameters
filter.id
integer
Example:

An integer to filter by order id.

filter.id_operator
string
Example:

The operator used for "id" filtering. May be one of gt, gte, lt, lte. Default value is equal.

filter.date
string
Example:

A date to filter by order created.

filter.date_operator
string
Example:

The operator used for "date" filtering. May be one of gt, gte, lt, lte. Default value is equal.

filter.order_status
string
Example:

A status to filter by order status. May be one of open, closed, cancelled.

filter.order_fulfilment_status
string
Example:

A status to filter by order fulfilment status. May be one of awaiting_confirmation, on_hold, partially_fulfilled, fulfilled.

filter.order_payment_status
string
Example:

A status to filter by order fulfilment status. May be one of pending, overdue, partially_paid, paid, chargeback, partially_refunded, refunded, voided.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Show order details

Authorizations:
default
path Parameters
id
required
integer

The ID of the order.

header Parameters
Authorization
string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type
string
Example: application/json
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}