API clients

API clients represent applications or tools that need to interact with OrderCloud to send requests and receive data.

ApiClients.List

List API clients

get

v1/apiclients

ApiClients.Create

Create an API client

post

v1/apiclients

ApiClients.ListAssignments

List API client assignments

get

v1/apiclients/assignments

ApiClients.SaveAssignment

Create or update an API client assignment

post

v1/apiclients/assignments

ApiClients.Get

Retrieve an API client

get

v1/apiclients/{apiClientID}

ApiClients.Save

Create or update an API client

put

v1/apiclients/{apiClientID}

ApiClients.Delete

Delete an API client

delete

v1/apiclients/{apiClientID}

ApiClients.Patch

Partially update an API client

patch

v1/apiclients/{apiClientID}

ApiClients.ListSecrets

List API client secrets

get

v1/apiclients/{apiClientID}/secrets

ApiClients.CreateSecret

Create an API client secret

post

v1/apiclients/{apiClientID}/secrets

ApiClients.GetSecret

Retrieve an API client secret

get

v1/apiclients/{apiClientID}/secrets/{apiClientSecretID}

ApiClients.DeleteSecret

Delete an API client secret

delete

v1/apiclients/{apiClientID}/secrets/{apiClientSecretID}

ApiClients.PatchSecret

Partially update an API client secret

patch

v1/apiclients/{apiClientID}/secrets/{apiClientSecretID}

ApiClients.DeleteBuyerAssignment

Delete an API client buyer assignment

delete

v1/buyers/{buyerID}/ApiClients/Assignments/{apiClientID}

ApiClients.DeleteSupplierAssignment

Delete an API client supplier assignment

delete

v1/suppliers/{supplierID}/ApiClients/Assignments/{apiClientID}