PUT

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Your supplier external_id, or the Melonn supplier id. The value is matched against external_id first; if none of your suppliers has that external_id and the value is a positive integer, it is matched against the Melonn id.

Minimum string length: 1

Body

application/json

Send only what changes. At least one property is required.

name
string

Supplier name. Cannot be blank.

Pattern: \S
active
boolean

Whether the supplier is active.

id_type
enum<string>

Identification type. Must be valid in a country where your account is active.

Available options:
CC,
NIT,
OTHER,
INE,
CURP,
RFC
id_number
string

Identification number. Cannot be blank.

Pattern: \S
notifications_email
string<email>

Email for supplier notifications. Must be a valid email.

phone_number
string

Supplier phone number. Cannot be blank.

Pattern: \S
external_id
string

Your own identifier for the supplier. Unique per seller. Cannot be blank.

Pattern: \S
warehouse_configurations
object[]

Configurations to write. Each one replaces the configuration of its warehouse in full (omitted values are reset to their defaults). Requires a negotiated agreement with Melonn.

Response

Supplier updated. Returns the supplier with its warehouse_configurations.

A supplier of your account.

id
integer

Melonn id of the supplier.

name
string

Supplier name.

id_type
string

Identification type.

id_number
string | null

Identification number.

active
boolean

Whether the supplier is active. Supplier orders can only be created for active suppliers.

phone_number
string

Supplier phone number.

notifications_email
string

Email for supplier notifications.

external_id
string | null

Your own identifier for the supplier, or null.

warehouse_configurations
object[]