Full-replaces a single sub-supplier.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id} \
--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": [
{
"id": 123,
"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/sub-suppliers/{id}"
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": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": ["<string>"],
"countryCode": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
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: [
{
id: 123,
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/sub-suppliers/{id}', 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/sub-suppliers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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' => [
[
'id' => 123,
'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/sub-suppliers/{id}"
payload := strings.NewReader("{\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 \"id\": 123,\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}")
req, _ := http.NewRequest("PUT", 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.put("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id}")
.header("Content-Type", "application/json")
.body("{\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 \"id\": 123,\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\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 \"id\": 123,\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}"
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": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}SubSuppliers
Full-replaces a single sub-supplier.
Idempotent full replace. Name and state are required. Optional scalar fields sent as null are cleared in the database. State must be ‘active’ or ‘archived’; state=deleted is not supported here, use DELETE instead. Contacts is a full replacement: omitting the field or sending an empty array clears all contacts. For partial updates that preserve omitted fields, use PATCH.
PUT
/
api
/
sub-suppliers
/
{id}
Full-replaces a single sub-supplier.
curl --request PUT \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id} \
--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": [
{
"id": 123,
"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/sub-suppliers/{id}"
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": [
{
"id": 123,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"faxNumber": "<string>",
"properties": ["<string>"],
"countryCode": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
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: [
{
id: 123,
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/sub-suppliers/{id}', 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/sub-suppliers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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' => [
[
'id' => 123,
'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/sub-suppliers/{id}"
payload := strings.NewReader("{\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 \"id\": 123,\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}")
req, _ := http.NewRequest("PUT", 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.put("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id}")
.header("Content-Type", "application/json")
.body("{\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 \"id\": 123,\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/sub-suppliers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\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 \"id\": 123,\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}"
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": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Path Parameters
The unique identifier of the sub-supplier to operate on.
Body
application/jsontext/jsonapplication/*+json
Display name of the sub-supplier company. Required; it cannot be null or empty.
Customer-defined identifier for the sub-supplier. On a full replace, sending null clears the stored value.
The commercial relationship the sub-supplier has with the supplier organization. On a full replace, sending null clears it.
Available options:
distributor, itemSupplier, sourcingAgency, styleSupplier Street address of the sub-supplier. On a full replace, sending null clears the stored value.
Postal or ZIP code of the sub-supplier's location. On a full replace, sending null clears the stored value.
City of the sub-supplier's location. On a full replace, sending null clears the stored value.
State, province, or region of the sub-supplier's location. On a full replace, sending null clears the stored value.
Country code of the sub-supplier's location, such as CN. On a full replace, sending null clears the stored value.
Latitude of the sub-supplier's location in decimal degrees. On a full replace, sending null clears the stored value.
Longitude of the sub-supplier's location in decimal degrees. On a full replace, sending null clears the stored value.
Website URL of the sub-supplier. On a full replace, sending null clears the stored value.
VAT registration number of the sub-supplier. On a full replace, sending null clears the stored value.
Manufacturer Identification (MID) number used for customs and import documentation. On a full replace, sending null clears it.
Hex color for the sub-supplier's avatar in the UI, without a leading hash character. On a full replace, sending null clears it.
The lifecycle state to assign on a full replace. Required. Deletion is not permitted here; use the DELETE endpoint to remove a sub-supplier.
Available options:
active, archived, deleted The complete set of contacts for the sub-supplier. On a full replace, this list replaces all existing contacts.
Show child attributes
Show child attributes
Response
OK
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