Skip to content

Suppliers

The party that sells your organisation the goods or merchandise.

Operations

Upload list of suppliers

Request

POST https://api.zoined.com/suppliers?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
supplier_idstringrequired

Supplier ID

Example:"221"
supplier_namestring

Supplier name

Example:"WasSuppliers"
supplier_emailstring

Supplier Email

Example:"john.smith@supplier.supplier"
supplier_phonestring

Supplier phone number

Example:"+3581111111"
supplier_addressstring

Street address

Example:"Mannerheimintie 1"
supplier_citystring

City

Example:"Helsinki"
supplier_zipcodestring

Postal code

Example:"00100"
supplier_countrystring

Country

Example:"Finland"
supplier_groupstring

Supplier group

Example:"Strategic Supplier"
supplier_typestring

Supplier type

Example:"Local"
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/suppliers?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "supplier_id": "221",
    "supplier_name": "WasSuppliers",
    "supplier_email": "john.smith@supplier.supplier",
    "supplier_phone": "+3581111111",
    "supplier_address": "Mannerheimintie 1",
    "supplier_city": "Helsinki",
    "supplier_zipcode": "00100",
    "supplier_country": "Finland",
    "supplier_group": "Strategic Supplier",
    "supplier_type": "Local",
    "custom_field_1": "XYZ",
    "custom_field_2": "XYZ",
    "custom_field_3": "XYZ",
    "custom_field_4": "XYZ",
    "custom_field_5": "XYZ",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}