[v2.6] Vendor

Owned by Megan Stanage

Sept 03, 2024

1 min read

Overview

This endpoint allows the upload of vendors from the host system into SCC.

POST /Vendor

Request Body

Property	Data Type	Notes
name	string	Vendor ID.
description	string	Vendor name.
active	boolean
website	string	URL for vendors website.
accessGroup	string	What system access group does this vendor belong in?

address

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

contacts

Property	Data Type	Notes
name	string
phone	string
email	string
isDefaultEmail	boolean
isDefaultPhone	boolean

systemAttributes

Property	Data Type	Notes
attributeName	string
attributeDescription	string
value	string

tradingPartnerAddresses

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30
addressName	string	max length: 100
addressType	string
locationNotes	string	max length: 500
isDefault	boolean

Response

Property	Data Type	Notes
savedVendors	string

saveFailures

Property	Data Type	Notes
name	string
errorMessage	string

Feedback

Submit feedback.