Creates one or more sub-suppliers for a supplier organization.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"customId": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": [
"<string>"
],
"countryCode": "<string>"
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers"
payload = [
{
"name": "<string>",
"customId": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": ["<string>"],
"countryCode": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
customId: '<string>',
address: '<string>',
zipCode: '<string>',
city: '<string>',
stateOrRegion: '<string>',
countryCode: '<string>',
latitude: 123,
longitude: 123,
webSite: '<string>',
vatNumber: '<string>',
mid: '<string>',
avatarColor: '<string>',
contacts: [
{
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
role: '<string>',
faxNumber: '<string>',
properties: ['<string>'],
countryCode: '<string>'
}
]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => '<string>',
'customId' => '<string>',
'address' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateOrRegion' => '<string>',
'countryCode' => '<string>',
'latitude' => 123,
'longitude' => 123,
'webSite' => '<string>',
'vatNumber' => '<string>',
'mid' => '<string>',
'avatarColor' => '<string>',
'contacts' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'role' => '<string>',
'faxNumber' => '<string>',
'properties' => [
'<string>'
],
'countryCode' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": "<string>",
"organizationId": 123,
"name": "<string>",
"customId": "<string>",
"relationType": "distributor",
"relationTypeName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"processingTypes": "<string>",
"facilityCount": 123,
"state": "active",
"createdAt": "2023-11-07T05:31:56Z",
"contacts": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": [
"<string>"
],
"countryCode": "<string>",
"countryName": "<string>"
}
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}SubSuppliers
Creates one or more sub-suppliers for a supplier organization.
Body is always an array, even for a single item. Scoped to the supplier organization identified by in the path. The caller must belong to that supplier org (supplier user) or have an active supplier-designer link to it (designer user). All items are created within a single transaction — all succeed or all fail. Name must be unique within the organization; duplicate names return 409. Capped at 200 items per request.
POST
/
api
/
organizations
/
{organizationId}
/
sub-suppliers
Creates one or more sub-suppliers for a supplier organization.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"customId": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": [
"<string>"
],
"countryCode": "<string>"
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers"
payload = [
{
"name": "<string>",
"customId": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"contacts": [
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": ["<string>"],
"countryCode": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: '<string>',
customId: '<string>',
address: '<string>',
zipCode: '<string>',
city: '<string>',
stateOrRegion: '<string>',
countryCode: '<string>',
latitude: 123,
longitude: 123,
webSite: '<string>',
vatNumber: '<string>',
mid: '<string>',
avatarColor: '<string>',
contacts: [
{
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
role: '<string>',
faxNumber: '<string>',
properties: ['<string>'],
countryCode: '<string>'
}
]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => '<string>',
'customId' => '<string>',
'address' => '<string>',
'zipCode' => '<string>',
'city' => '<string>',
'stateOrRegion' => '<string>',
'countryCode' => '<string>',
'latitude' => 123,
'longitude' => 123,
'webSite' => '<string>',
'vatNumber' => '<string>',
'mid' => '<string>',
'avatarColor' => '<string>',
'contacts' => [
[
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'role' => '<string>',
'faxNumber' => '<string>',
'properties' => [
'<string>'
],
'countryCode' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/organizations/{organizationId}/sub-suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"name\": \"<string>\",\n \"customId\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"stateOrRegion\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"webSite\": \"<string>\",\n \"vatNumber\": \"<string>\",\n \"mid\": \"<string>\",\n \"avatarColor\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"properties\": [\n \"<string>\"\n ],\n \"countryCode\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": "<string>",
"organizationId": 123,
"name": "<string>",
"customId": "<string>",
"relationType": "distributor",
"relationTypeName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"city": "<string>",
"stateOrRegion": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"latitude": 123,
"longitude": 123,
"webSite": "<string>",
"vatNumber": "<string>",
"mid": "<string>",
"avatarColor": "<string>",
"processingTypes": "<string>",
"facilityCount": 123,
"state": "active",
"createdAt": "2023-11-07T05:31:56Z",
"contacts": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": [
"<string>"
],
"countryCode": "<string>",
"countryName": "<string>"
}
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Path Parameters
The numeric identifier of the supplier organization to scope the request to. The caller must belong to it or have an active supplier-designer link.
Body
application/jsontext/jsonapplication/*+json
Display name of the sub-supplier company. Required and limited to 255 characters.
Customer-defined identifier for the sub-supplier.
The commercial relationship the sub-supplier has with the supplier organization.
Available options:
distributor, itemSupplier, sourcingAgency, styleSupplier Street address of the sub-supplier.
Postal or ZIP code of the sub-supplier's location.
City of the sub-supplier's location.
State, province, or region of the sub-supplier's location.
Country code of the sub-supplier's location, such as CN. Required.
Latitude of the sub-supplier's location in decimal degrees.
Longitude of the sub-supplier's location in decimal degrees.
Website URL of the sub-supplier.
VAT registration number of the sub-supplier.
Manufacturer Identification (MID) number used for customs and import documentation.
Hex color used for the sub-supplier's avatar in the UI, without a leading hash character.
Contact persons to create for the sub-supplier.
Show child attributes
Show child attributes
Response
Created
The coarse outcome of the request, indicating whether it succeeded or failed.
Available options:
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.
Show child attributes
Show child attributes