Partners

Business partners — suppliers and customers used in Stock In and Stock Out transactions.

L’objet Partner

Partner — a supplier or customer used as the counterparty on Stock In and Stock Out transactions.

idintegerminimum 0, maximum 2147483647obligatoire

Partner id.

typenumberobligatoire

Partner classification. 0 = supplier (used in Stock In transactions), 1 = customer (used in Stock Out transactions).

Valeurs possibles01

namestringobligatoire

Partner display name.

phonestringobligatoire

Phone number. Empty string when not set.

emailstringobligatoire

Email address. Empty string when not set.

addressstringobligatoire

Postal address. Empty string when not set.

memostringobligatoire

Free-text memo. Empty string when not set.

Exemple

{
  "id": 431485,
  "type": 0,
  "name": "Acme Supply Co.",
  "phone": "+1-415-555-0101",
  "email": "orders@acme-supply.example.com",
  "address": "123 Market St, San Francisco, CA 94103",
  "memo": ""
}

Points de terminaison

List partners GET /v1/partners
Create a partner POST /v1/partners
Get a partner GET /v1/partners/{partner_id}
Update a partner PUT /v1/partners/{partner_id}
Delete a partner DELETE /v1/partners/{partner_id}