ordercloud-javascript-sdk

OrderCloud

OrderCloud - JavaScript SDK for OrderCloud

OrderCloud.io is a cloud-hosted B2B eCommerce platform exposed entirely via a RESTful API. When combined with our extensive library of components, SDKs, and deployment tools, it enables rapid development of custom, secure, and scalable B2B eCommerce solutions. Spin up a fully functional B2B app in minutes, and customize it to limits of your imagination.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.59
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

For more information, please visit https://documentation.ordercloud.io

Installation

npm

npm install ordercloud-javascript-sdk --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming index.js is your entry file):

browserify index.js > bundle.js

Then include bundle.js in the HTML pages.

Authentication

We'll need to get a token before we can make any API calls. The platform offers four different auth workflows all found under the Auth class.

We'll use the password-grant type for this example.

var OrderCloud = require('ordercloud-javascript-sdk')
var defaultClient = OrderCloud.ApiClient.instance;

var username = 'YOUR_USERNAME'; //username of the user logging in
var password = 'YOUR_PASSWORD'; //password of the user logging in
var clientID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'; //clientID of the application the user is logging in to ([sign up for free](https://account.ordercloud.io/login/)
var scope = ['FullAccess']; //string array of roles the application has access to ([more info](https://documentation.ordercloud.io/platform-guides/authentication/security-profiles)) 

return OrderCloud.Auth.Login(username, password, clientID, scope)
  .then(function(response){
    //store token, now any subsequent calls will automatically set this token in the headers for you
    var token = response['access_token'];
    defaultClient.authentications['oauth2'].accessToken = token;
  })
  .catch(function(err){
    //there was an error
    console.log(err);
  });

Example

After following the authentication instructions we can make any API call very easily.

Let's get the currently authenticated user's details with a Me.Get()

return OrderCloudSDK.Me.Get()
  .then(function(user){
    console.log("This user's name is " + user.FirstName + " " + user.LastName);
  })
  .catch(function(err){
    //there was an error
    console.log(err);
  })

Further Reading

You should now have enough information to get started building on our platform! The platform guides[https://documentation.ordercloud.io/platform-guides] and API reference should be your go-to guide for working with the API.

Documentation for API Endpoints

All URIs are relative to https://api.ordercloud.io/v1

Class	Method	HTTP request	Description
OrderCloud.Addresses	Create	POST /buyers/{buyerID}/addresses
OrderCloud.Addresses	Delete	DELETE /buyers/{buyerID}/addresses/{addressID}
OrderCloud.Addresses	DeleteAssignment	DELETE /buyers/{buyerID}/addresses/{addressID}/assignments
OrderCloud.Addresses	Get	GET /buyers/{buyerID}/addresses/{addressID}
OrderCloud.Addresses	List	GET /buyers/{buyerID}/addresses
OrderCloud.Addresses	ListAssignments	GET /buyers/{buyerID}/addresses/assignments
OrderCloud.Addresses	Patch	PATCH /buyers/{buyerID}/addresses/{addressID}
OrderCloud.Addresses	SaveAssignment	POST /buyers/{buyerID}/addresses/assignments
OrderCloud.Addresses	Update	PUT /buyers/{buyerID}/addresses/{addressID}
OrderCloud.AdminAddresses	Create	POST /addresses
OrderCloud.AdminAddresses	Delete	DELETE /addresses/{addressID}
OrderCloud.AdminAddresses	Get	GET /addresses/{addressID}
OrderCloud.AdminAddresses	List	GET /addresses
OrderCloud.AdminAddresses	Patch	PATCH /addresses/{addressID}
OrderCloud.AdminAddresses	Update	PUT /addresses/{addressID}
OrderCloud.AdminUsers	Create	POST /adminusers
OrderCloud.AdminUsers	Delete	DELETE /adminusers/{userID}
OrderCloud.AdminUsers	Get	GET /adminusers/{userID}
OrderCloud.AdminUsers	List	GET /adminusers
OrderCloud.AdminUsers	Patch	PATCH /adminusers/{userID}
OrderCloud.AdminUsers	Update	PUT /adminusers/{userID}
OrderCloud.AdminUserGroups	Create	POST /usergroups
OrderCloud.AdminUserGroups	Delete	DELETE /usergroups/{userGroupID}
OrderCloud.AdminUserGroups	DeleteUserAssignment	DELETE /usergroups/{userGroupID}/assignments/{userID}
OrderCloud.AdminUserGroups	Get	GET /usergroups/{userGroupID}
OrderCloud.AdminUserGroups	List	GET /usergroups
OrderCloud.AdminUserGroups	ListUserAssignments	GET /usergroups/assignments
OrderCloud.AdminUserGroups	Patch	PATCH /usergroups/{userGroupID}
OrderCloud.AdminUserGroups	SaveUserAssignment	POST /usergroups/assignments
OrderCloud.AdminUserGroups	Update	PUT /usergroups/{userGroupID}
OrderCloud.ApprovalRules	Create	POST /buyers/{buyerID}/approvalrules
OrderCloud.ApprovalRules	Delete	DELETE /buyers/{buyerID}/approvalrules/{approvalRuleID}
OrderCloud.ApprovalRules	Get	GET /buyers/{buyerID}/approvalrules/{approvalRuleID}
OrderCloud.ApprovalRules	List	GET /buyers/{buyerID}/approvalrules
OrderCloud.ApprovalRules	Patch	PATCH /buyers/{buyerID}/approvalrules/{approvalRuleID}
OrderCloud.ApprovalRules	Update	PUT /buyers/{buyerID}/approvalrules/{approvalRuleID}
OrderCloud.Buyers	Create	POST /buyers
OrderCloud.Buyers	Delete	DELETE /buyers/{buyerID}
OrderCloud.Buyers	Get	GET /buyers/{buyerID}
OrderCloud.Buyers	List	GET /buyers
OrderCloud.Buyers	Patch	PATCH /buyers/{buyerID}
OrderCloud.Buyers	Update	PUT /buyers/{buyerID}
OrderCloud.Catalogs	Create	POST /catalogs
OrderCloud.Catalogs	Delete	DELETE /catalogs/{catalogID}
OrderCloud.Catalogs	DeleteAssignment	DELETE /catalogs/{catalogID}/assignments
OrderCloud.Catalogs	DeleteProductAssignment	DELETE /catalogs/{catalogID}/productassignments/{productID}
OrderCloud.Catalogs	Get	GET /catalogs/{catalogID}
OrderCloud.Catalogs	List	GET /catalogs
OrderCloud.Catalogs	ListAssignments	GET /catalogs/assignments
OrderCloud.Catalogs	ListProductAssignments	GET /catalogs/productassignments
OrderCloud.Catalogs	Patch	PATCH /catalogs/{catalogID}
OrderCloud.Catalogs	SaveAssignment	POST /catalogs/assignments
OrderCloud.Catalogs	SaveProductAssignment	POST /catalogs/productassignments
OrderCloud.Catalogs	Update	PUT /catalogs/{catalogID}
OrderCloud.Categories	Create	POST /catalogs/{catalogID}/categories
OrderCloud.Categories	Delete	DELETE /catalogs/{catalogID}/categories/{categoryID}
OrderCloud.Categories	DeleteAssignment	DELETE /catalogs/{catalogID}/categories/{categoryID}/assignments
OrderCloud.Categories	DeleteProductAssignment	DELETE /catalogs/{catalogID}/categories/{categoryID}/productassignments/{productID}
OrderCloud.Categories	Get	GET /catalogs/{catalogID}/categories/{categoryID}
OrderCloud.Categories	List	GET /catalogs/{catalogID}/categories
OrderCloud.Categories	ListAssignments	GET /catalogs/{catalogID}/categories/assignments
OrderCloud.Categories	ListProductAssignments	GET /catalogs/{catalogID}/categories/productassignments
OrderCloud.Categories	Patch	PATCH /catalogs/{catalogID}/categories/{categoryID}
OrderCloud.Categories	SaveAssignment	POST /catalogs/{catalogID}/categories/assignments
OrderCloud.Categories	SaveProductAssignment	POST /catalogs/{catalogID}/categories/productassignments
OrderCloud.Categories	Update	PUT /catalogs/{catalogID}/categories/{categoryID}
OrderCloud.CostCenters	Create	POST /buyers/{buyerID}/costcenters
OrderCloud.CostCenters	Delete	DELETE /buyers/{buyerID}/costcenters/{costCenterID}
OrderCloud.CostCenters	DeleteAssignment	DELETE /buyers/{buyerID}/costcenters/{costCenterID}/assignments
OrderCloud.CostCenters	Get	GET /buyers/{buyerID}/costcenters/{costCenterID}
OrderCloud.CostCenters	List	GET /buyers/{buyerID}/costcenters
OrderCloud.CostCenters	ListAssignments	GET /buyers/{buyerID}/costcenters/assignments
OrderCloud.CostCenters	Patch	PATCH /buyers/{buyerID}/costcenters/{costCenterID}
OrderCloud.CostCenters	SaveAssignment	POST /buyers/{buyerID}/costcenters/assignments
OrderCloud.CostCenters	Update	PUT /buyers/{buyerID}/costcenters/{costCenterID}
OrderCloud.CreditCards	Create	POST /buyers/{buyerID}/creditcards
OrderCloud.CreditCards	Delete	DELETE /buyers/{buyerID}/creditcards/{creditCardID}
OrderCloud.CreditCards	DeleteAssignment	DELETE /buyers/{buyerID}/creditcards/{creditCardID}/assignments
OrderCloud.CreditCards	Get	GET /buyers/{buyerID}/creditcards/{creditCardID}
OrderCloud.CreditCards	List	GET /buyers/{buyerID}/creditcards
OrderCloud.CreditCards	ListAssignments	GET /buyers/{buyerID}/creditcards/assignments
OrderCloud.CreditCards	Patch	PATCH /buyers/{buyerID}/creditcards/{creditCardID}
OrderCloud.CreditCards	SaveAssignment	POST /buyers/{buyerID}/creditcards/assignments
OrderCloud.CreditCards	Update	PUT /buyers/{buyerID}/creditcards/{creditCardID}
OrderCloud.ImpersonationConfigs	Create	POST /impersonationconfig
OrderCloud.ImpersonationConfigs	Delete	DELETE /impersonationconfig/{impersonationConfigID}
OrderCloud.ImpersonationConfigs	Get	GET /impersonationconfig/{impersonationConfigID}
OrderCloud.ImpersonationConfigs	List	GET /impersonationconfig
OrderCloud.ImpersonationConfigs	Patch	PATCH /impersonationconfig/{impersonationConfigID}
OrderCloud.ImpersonationConfigs	Update	PUT /impersonationconfig/{impersonationConfigID}
OrderCloud.LineItems	Create	POST /orders/{direction}/{orderID}/lineitems
OrderCloud.LineItems	Delete	DELETE /orders/{direction}/{orderID}/lineitems/{lineItemID}
OrderCloud.LineItems	Get	GET /orders/{direction}/{orderID}/lineitems/{lineItemID}
OrderCloud.LineItems	List	GET /orders/{direction}/{orderID}/lineitems
OrderCloud.LineItems	Patch	PATCH /orders/{direction}/{orderID}/lineitems/{lineItemID}
OrderCloud.LineItems	PatchShippingAddress	PATCH /orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto
OrderCloud.LineItems	SetShippingAddress	PUT /orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto
OrderCloud.LineItems	Update	PUT /orders/{direction}/{orderID}/lineitems/{lineItemID}
OrderCloud.Me	CreateAddress	POST /me/addresses
OrderCloud.Me	CreateCreditCard	POST /me/creditcards
OrderCloud.Me	DeleteAddress	DELETE /me/addresses/{addressID}
OrderCloud.Me	DeleteCreditCard	DELETE /me/creditcards/{creditcardID}
OrderCloud.Me	Get	GET /me
OrderCloud.Me	GetAddress	GET /me/addresses/{addressID}
OrderCloud.Me	GetCatalog	GET /me/catalogs/{catalogID}
OrderCloud.Me	GetCreditCard	GET /me/creditcards/{creditcardID}
OrderCloud.Me	GetProduct	GET /me/products/{productID}
OrderCloud.Me	GetPromotion	GET /me/promotions/{promotionID}
OrderCloud.Me	GetShipment	GET /me/shipments/{shipmentID}
OrderCloud.Me	GetSpec	GET /me/products/{productID}/specs/{specID}
OrderCloud.Me	GetSpendingAccount	GET /me/spendingaccounts/{spendingAccountID}
OrderCloud.Me	ListAddresses	GET /me/addresses
OrderCloud.Me	ListApprovableOrders	GET /me/orders/approvable
OrderCloud.Me	ListCatalogs	GET /me/catalogs
OrderCloud.Me	ListCategories	GET /me/categories
OrderCloud.Me	ListCostCenters	GET /me/costcenters
OrderCloud.Me	ListCreditCards	GET /me/creditcards
OrderCloud.Me	ListOrders	GET /me/orders
OrderCloud.Me	ListProducts	GET /me/products
OrderCloud.Me	ListPromotions	GET /me/promotions
OrderCloud.Me	ListShipmentItems	GET /me/shipments/{shipmentID}/items
OrderCloud.Me	ListShipments	GET /me/shipments
OrderCloud.Me	ListSpecs	GET /me/products/{productID}/specs
OrderCloud.Me	ListSpendingAccounts	GET /me/spendingAccounts
OrderCloud.Me	ListUserGroups	GET /me/usergroups
OrderCloud.Me	Patch	PATCH /me
OrderCloud.Me	PatchAddress	PATCH /me/addresses/{addressID}
OrderCloud.Me	PatchCreditCard	PATCH /me/creditcards/{creditcardID}
OrderCloud.Me	Register	PUT /me/register
OrderCloud.Me	ResetPasswordByToken	POST /me/password
OrderCloud.Me	TransferAnonUserOrder	PUT /me/orders
OrderCloud.Me	Update	PUT /me
OrderCloud.Me	UpdateAddress	PUT /me/addresses/{addressID}
OrderCloud.Me	UpdateCreditCard	PUT /me/creditcards/{creditcardID}
OrderCloud.MessageSenders	DeleteAssignment	DELETE /messagesenders/{messageSenderID}/assignments
OrderCloud.MessageSenders	Get	GET /messagesenders/{messageSenderID}
OrderCloud.MessageSenders	List	GET /messagesenders
OrderCloud.MessageSenders	ListAssignments	GET /messagesenders/assignments
OrderCloud.MessageSenders	ListCCListenerAssignments	GET /messagesenders/CCListenerAssignments
OrderCloud.MessageSenders	SaveAssignment	POST /messagesenders/assignments
OrderCloud.MessageSenders	SaveCCListenerAssignment	POST /messagesenders/CCListenerAssignments
OrderCloud.Orders	AddPromotion	POST /orders/{direction}/{orderID}/promotions/{promoCode}
OrderCloud.Orders	Approve	POST /orders/{direction}/{orderID}/approve
OrderCloud.Orders	Cancel	POST /orders/{direction}/{orderID}/cancel
OrderCloud.Orders	Create	POST /orders/{direction}
OrderCloud.Orders	Decline	POST /orders/{direction}/{orderID}/decline
OrderCloud.Orders	Delete	DELETE /orders/{direction}/{orderID}
OrderCloud.Orders	Get	GET /orders/{direction}/{orderID}
OrderCloud.Orders	List	GET /orders/{direction}
OrderCloud.Orders	ListApprovals	GET /orders/{direction}/{orderID}/approvals
OrderCloud.Orders	ListEligibleApprovers	GET /orders/{direction}/{orderID}/eligibleapprovers
OrderCloud.Orders	ListPromotions	GET /orders/{direction}/{orderID}/promotions
OrderCloud.Orders	Patch	PATCH /orders/{direction}/{orderID}
OrderCloud.Orders	PatchBillingAddress	PATCH /orders/{direction}/{orderID}/billto
OrderCloud.Orders	PatchShippingAddress	PATCH /orders/{direction}/{orderID}/shipto
OrderCloud.Orders	RemovePromotion	DELETE /orders/{direction}/{orderID}/promotions/{promoCode}
OrderCloud.Orders	SetBillingAddress	PUT /orders/{direction}/{orderID}/billto
OrderCloud.Orders	SetShippingAddress	PUT /orders/{direction}/{orderID}/shipto
OrderCloud.Orders	Ship	POST /orders/{direction}/{orderID}/ship
OrderCloud.Orders	Submit	POST /orders/{direction}/{orderID}/submit
OrderCloud.Orders	Update	PUT /orders/{direction}/{orderID}
OrderCloud.PasswordResets	ResetPasswordByVerificationCode	PUT /password/reset/{verificationCode}
OrderCloud.PasswordResets	SendVerificationCode	POST /password/reset
OrderCloud.Payments	Create	POST /orders/{direction}/{orderID}/payments
OrderCloud.Payments	CreateTransaction	POST /orders/{direction}/{orderID}/payments/{paymentID}/transactions
OrderCloud.Payments	Delete	DELETE /orders/{direction}/{orderID}/payments/{paymentID}
OrderCloud.Payments	DeleteTransaction	DELETE /orders/{direction}/{orderID}/payments/{paymentID}/transactions/{transactionID}
OrderCloud.Payments	Get	GET /orders/{direction}/{orderID}/payments/{paymentID}
OrderCloud.Payments	List	GET /orders/{direction}/{orderID}/payments
OrderCloud.Payments	Patch	PATCH /orders/{direction}/{orderID}/payments/{paymentID}
OrderCloud.PriceSchedules	Create	POST /priceschedules
OrderCloud.PriceSchedules	Delete	DELETE /priceschedules/{priceScheduleID}
OrderCloud.PriceSchedules	DeletePriceBreak	DELETE /priceschedules/{priceScheduleID}/PriceBreaks
OrderCloud.PriceSchedules	Get	GET /priceschedules/{priceScheduleID}
OrderCloud.PriceSchedules	List	GET /priceschedules
OrderCloud.PriceSchedules	Patch	PATCH /priceschedules/{priceScheduleID}
OrderCloud.PriceSchedules	SavePriceBreak	POST /priceschedules/{priceScheduleID}/PriceBreaks
OrderCloud.PriceSchedules	Update	PUT /priceschedules/{priceScheduleID}
OrderCloud.Products	Create	POST /products
OrderCloud.Products	Delete	DELETE /products/{productID}
OrderCloud.Products	DeleteAssignment	DELETE /products/{productID}/assignments/{buyerID}
OrderCloud.Products	GenerateVariants	POST /products/{productID}/variants/generate
OrderCloud.Products	Get	GET /products/{productID}
OrderCloud.Products	GetVariant	GET /products/{productID}/variants/{variantID}
OrderCloud.Products	List	GET /products
OrderCloud.Products	ListAssignments	GET /products/assignments
OrderCloud.Products	ListSuppliers	GET /products/{productID}/suppliers
OrderCloud.Products	ListVariants	GET /products/{productID}/variants
OrderCloud.Products	Patch	PATCH /products/{productID}
OrderCloud.Products	PatchVariant	PATCH /products/{productID}/variants/{variantID}
OrderCloud.Products	RemoveSupplier	DELETE /products/{productID}/suppliers/{supplierID}
OrderCloud.Products	SaveAssignment	POST /products/assignments
OrderCloud.Products	SaveSupplier	PUT /products/{productID}/suppliers/{supplierID}
OrderCloud.Products	Update	PUT /products/{productID}
OrderCloud.Products	UpdateVariant	PUT /products/{productID}/variants/{variantID}
OrderCloud.Promotions	Create	POST /promotions
OrderCloud.Promotions	Delete	DELETE /promotions/{promotionID}
OrderCloud.Promotions	DeleteAssignment	DELETE /promotions/{promotionID}/assignments
OrderCloud.Promotions	Get	GET /promotions/{promotionID}
OrderCloud.Promotions	List	GET /promotions
OrderCloud.Promotions	ListAssignments	GET /promotions/assignments
OrderCloud.Promotions	Patch	PATCH /promotions/{promotionID}
OrderCloud.Promotions	SaveAssignment	POST /promotions/assignments
OrderCloud.Promotions	Update	PUT /promotions/{promotionID}
OrderCloud.SecurityProfiles	DeleteAssignment	DELETE /securityprofiles/{securityProfileID}/assignments
OrderCloud.SecurityProfiles	Get	GET /securityprofiles/{securityProfileID}
OrderCloud.SecurityProfiles	List	GET /securityprofiles
OrderCloud.SecurityProfiles	ListAssignments	GET /securityprofiles/assignments
OrderCloud.SecurityProfiles	SaveAssignment	POST /securityprofiles/assignments
OrderCloud.Shipments	Create	POST /shipments
OrderCloud.Shipments	Delete	DELETE /shipments/{shipmentID}
OrderCloud.Shipments	DeleteItem	DELETE /shipments/{shipmentID}/items/{orderID}/{lineItemID}
OrderCloud.Shipments	Get	GET /shipments/{shipmentID}
OrderCloud.Shipments	GetItem	GET /shipments/{shipmentID}/items/{orderID}/{lineItemID}
OrderCloud.Shipments	List	GET /shipments
OrderCloud.Shipments	ListItems	GET /shipments/{shipmentID}/items
OrderCloud.Shipments	Patch	PATCH /shipments/{shipmentID}
OrderCloud.Shipments	SaveItem	POST /shipments/{shipmentID}/items
OrderCloud.Shipments	Update	PUT /shipments/{shipmentID}
OrderCloud.Specs	Create	POST /specs
OrderCloud.Specs	CreateOption	POST /specs/{specID}/options
OrderCloud.Specs	Delete	DELETE /specs/{specID}
OrderCloud.Specs	DeleteOption	DELETE /specs/{specID}/options/{optionID}
OrderCloud.Specs	DeleteProductAssignment	DELETE /specs/{specID}/productassignments/{productID}
OrderCloud.Specs	Get	GET /specs/{specID}
OrderCloud.Specs	GetOption	GET /specs/{specID}/options/{optionID}
OrderCloud.Specs	List	GET /specs
OrderCloud.Specs	ListOptions	GET /specs/{specID}/options
OrderCloud.Specs	ListProductAssignments	GET /specs/productassignments
OrderCloud.Specs	Patch	PATCH /specs/{specID}
OrderCloud.Specs	PatchOption	PATCH /specs/{specID}/options/{optionID}
OrderCloud.Specs	SaveProductAssignment	POST /specs/productassignments
OrderCloud.Specs	Update	PUT /specs/{specID}
OrderCloud.Specs	UpdateOption	PUT /specs/{specID}/options/{optionID}
OrderCloud.SpendingAccounts	Create	POST /buyers/{buyerID}/spendingaccounts
OrderCloud.SpendingAccounts	Delete	DELETE /buyers/{buyerID}/spendingaccounts/{spendingAccountID}
OrderCloud.SpendingAccounts	DeleteAssignment	DELETE /buyers/{buyerID}/spendingaccounts/{spendingAccountID}/assignments
OrderCloud.SpendingAccounts	Get	GET /buyers/{buyerID}/spendingaccounts/{spendingAccountID}
OrderCloud.SpendingAccounts	List	GET /buyers/{buyerID}/spendingaccounts
OrderCloud.SpendingAccounts	ListAssignments	GET /buyers/{buyerID}/spendingaccounts/assignments
OrderCloud.SpendingAccounts	Patch	PATCH /buyers/{buyerID}/spendingaccounts/{spendingAccountID}
OrderCloud.SpendingAccounts	SaveAssignment	POST /buyers/{buyerID}/spendingaccounts/assignments
OrderCloud.SpendingAccounts	Update	PUT /buyers/{buyerID}/spendingaccounts/{spendingAccountID}
OrderCloud.Suppliers	Create	POST /suppliers
OrderCloud.Suppliers	Delete	DELETE /suppliers/{supplierID}
OrderCloud.Suppliers	Get	GET /suppliers/{supplierID}
OrderCloud.Suppliers	List	GET /suppliers
OrderCloud.Suppliers	Patch	PATCH /suppliers/{supplierID}
OrderCloud.Suppliers	Update	PUT /suppliers/{supplierID}
OrderCloud.SupplierUsers	Create	POST /suppliers/{supplierID}/users
OrderCloud.SupplierUsers	Delete	DELETE /suppliers/{supplierID}/users/{userID}
OrderCloud.SupplierUsers	Get	GET /suppliers/{supplierID}/users/{userID}
OrderCloud.SupplierUsers	GetAccessToken	POST /suppliers/{supplierID}/users/{userID}/accesstoken
OrderCloud.SupplierUsers	List	GET /suppliers/{supplierID}/users
OrderCloud.SupplierUsers	Patch	PATCH /suppliers/{supplierID}/users/{userID}
OrderCloud.SupplierUsers	Update	PUT /suppliers/{supplierID}/users/{userID}
OrderCloud.SupplierUserGroups	Create	POST /suppliers/{supplierID}/usergroups
OrderCloud.SupplierUserGroups	Delete	DELETE /suppliers/{supplierID}/usergroups/{userGroupID}
OrderCloud.SupplierUserGroups	DeleteUserAssignment	DELETE /suppliers/{supplierID}/usergroups/{userGroupID}/assignments/{userID}
OrderCloud.SupplierUserGroups	Get	GET /suppliers/{supplierID}/usergroups/{userGroupID}
OrderCloud.SupplierUserGroups	List	GET /suppliers/{supplierID}/usergroups
OrderCloud.SupplierUserGroups	ListUserAssignments	GET /suppliers/{supplierID}/usergroups/assignments
OrderCloud.SupplierUserGroups	Patch	PATCH /suppliers/{supplierID}/usergroups/{userGroupID}
OrderCloud.SupplierUserGroups	SaveUserAssignment	POST /suppliers/{supplierID}/usergroups/assignments
OrderCloud.SupplierUserGroups	Update	PUT /suppliers/{supplierID}/usergroups/{userGroupID}
OrderCloud.Users	Create	POST /buyers/{buyerID}/users
OrderCloud.Users	Delete	DELETE /buyers/{buyerID}/users/{userID}
OrderCloud.Users	Get	GET /buyers/{buyerID}/users/{userID}
OrderCloud.Users	GetAccessToken	POST /buyers/{buyerID}/users/{userID}/accesstoken
OrderCloud.Users	List	GET /buyers/{buyerID}/users
OrderCloud.Users	Patch	PATCH /buyers/{buyerID}/users/{userID}
OrderCloud.Users	Update	PUT /buyers/{buyerID}/users/{userID}
OrderCloud.UserGroups	Create	POST /buyers/{buyerID}/usergroups
OrderCloud.UserGroups	Delete	DELETE /buyers/{buyerID}/usergroups/{userGroupID}
OrderCloud.UserGroups	DeleteUserAssignment	DELETE /buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID}
OrderCloud.UserGroups	Get	GET /buyers/{buyerID}/usergroups/{userGroupID}
OrderCloud.UserGroups	List	GET /buyers/{buyerID}/usergroups
OrderCloud.UserGroups	ListUserAssignments	GET /buyers/{buyerID}/usergroups/assignments
OrderCloud.UserGroups	Patch	PATCH /buyers/{buyerID}/usergroups/{userGroupID}
OrderCloud.UserGroups	SaveUserAssignment	POST /buyers/{buyerID}/usergroups/assignments
OrderCloud.UserGroups	Update	PUT /buyers/{buyerID}/usergroups/{userGroupID}

Documentation for Models

• OrderCloud.AccessToken
• OrderCloud.Address
• OrderCloud.AddressAssignment
• OrderCloud.ApprovalRule
• OrderCloud.BaseSpec
• OrderCloud.Buyer
• OrderCloud.BuyerAddress
• OrderCloud.BuyerCreditCard
• OrderCloud.BuyerProduct
• OrderCloud.BuyerShipment
• OrderCloud.BuyerSpec
• OrderCloud.Catalog
• OrderCloud.CatalogAssignment
• OrderCloud.Category
• OrderCloud.CategoryAssignment
• OrderCloud.CategoryProductAssignment
• OrderCloud.CostCenter
• OrderCloud.CostCenterAssignment
• OrderCloud.CreditCard
• OrderCloud.CreditCardAssignment
• OrderCloud.ImpersonateTokenRequest
• OrderCloud.ImpersonationConfig
• OrderCloud.Inventory
• OrderCloud.LineItem
• OrderCloud.LineItemProduct
• OrderCloud.LineItemSpec
• OrderCloud.ListAddress
• OrderCloud.ListAddressAssignment
• OrderCloud.ListApprovalRule
• OrderCloud.ListArgs
• OrderCloud.ListBuyer
• OrderCloud.ListBuyerAddress
• OrderCloud.ListBuyerCreditCard
• OrderCloud.ListBuyerProduct
• OrderCloud.ListBuyerShipment
• OrderCloud.ListBuyerSpec
• OrderCloud.ListCatalog
• OrderCloud.ListCatalogAssignment
• OrderCloud.ListCategory
• OrderCloud.ListCategoryAssignment
• OrderCloud.ListCategoryProductAssignment
• OrderCloud.ListCostCenter
• OrderCloud.ListCostCenterAssignment
• OrderCloud.ListCreditCard
• OrderCloud.ListCreditCardAssignment
• OrderCloud.ListImpersonationConfig
• OrderCloud.ListLineItem
• OrderCloud.ListMessageCCListenerAssignment
• OrderCloud.ListMessageConfig
• OrderCloud.ListMessageSender
• OrderCloud.ListMessageSenderAssignment
• OrderCloud.ListOrder
• OrderCloud.ListOrderApproval
• OrderCloud.ListOrderPromotion
• OrderCloud.ListPayment
• OrderCloud.ListPriceSchedule
• OrderCloud.ListProduct
• OrderCloud.ListProductAssignment
• OrderCloud.ListProductCatalogAssignment
• OrderCloud.ListPromotion
• OrderCloud.ListPromotionAssignment
• OrderCloud.ListSecurityProfile
• OrderCloud.ListSecurityProfileAssignment
• OrderCloud.ListShipment
• OrderCloud.ListShipmentItem
• OrderCloud.ListSpec
• OrderCloud.ListSpecOption
• OrderCloud.ListSpecProductAssignment
• OrderCloud.ListSpendingAccount
• OrderCloud.ListSpendingAccountAssignment
• OrderCloud.ListSupplier
• OrderCloud.ListUser
• OrderCloud.ListUserGroup
• OrderCloud.ListUserGroupAssignment
• OrderCloud.ListVariant
• OrderCloud.MeBuyer
• OrderCloud.MeUser
• OrderCloud.MessageCCListenerAssignment
• OrderCloud.MessageConfig
• OrderCloud.MessageSender
• OrderCloud.MessageSenderAssignment
• OrderCloud.Meta
• OrderCloud.Order
• OrderCloud.OrderApproval
• OrderCloud.OrderApprovalInfo
• OrderCloud.OrderPromotion
• OrderCloud.PasswordReset
• OrderCloud.PasswordResetRequest
• OrderCloud.Payment
• OrderCloud.PaymentTransaction
• OrderCloud.PriceBreak
• OrderCloud.PriceSchedule
• OrderCloud.Product
• OrderCloud.ProductAssignment
• OrderCloud.ProductBase
• OrderCloud.ProductCatalogAssignment
• OrderCloud.Promotion
• OrderCloud.PromotionAssignment
• OrderCloud.SecurityProfile
• OrderCloud.SecurityProfileAssignment
• OrderCloud.Shipment
• OrderCloud.ShipmentItem
• OrderCloud.Spec
• OrderCloud.SpecOption
• OrderCloud.SpecProductAssignment
• OrderCloud.SpendingAccount
• OrderCloud.SpendingAccountAssignment
• OrderCloud.Supplier
• OrderCloud.TokenPasswordReset
• OrderCloud.User
• OrderCloud.UserGroup
• OrderCloud.UserGroupAssignment
• OrderCloud.Variant

Documentation for Authorization

oauth2

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
  • AddressAdmin:
  • AddressReader:
  • AdminAddressAdmin:
  • AdminAddressReader:
  • AdminUserAdmin:
  • AdminUserGroupAdmin:
  • AdminUserGroupReader:
  • AdminUserReader:
  • ApprovalRuleAdmin:
  • ApprovalRuleReader:
  • BuyerAdmin:
  • BuyerImpersonation:
  • BuyerReader:
  • BuyerUserAdmin:
  • BuyerUserReader:
  • CatalogAdmin:
  • CatalogReader:
  • CategoryAdmin:
  • CategoryReader:
  • CostCenterAdmin:
  • CostCenterReader:
  • CreditCardAdmin:
  • CreditCardReader:
  • FullAccess:
  • GrantForAnyRole:
  • InventoryAdmin:
  • MeAddressAdmin:
  • MeAdmin:
  • MeCreditCardAdmin:
  • MessageConfigAssignmentAdmin:
  • MeXpAdmin:
  • OrderAdmin:
  • OrderReader:
  • OverrideShipping:
  • OverrideTax:
  • OverrideUnitPrice:
  • PasswordReset:
  • PriceScheduleAdmin:
  • PriceScheduleReader:
  • ProductAdmin:
  • ProductAssignmentAdmin:
  • ProductReader:
  • PromotionAdmin:
  • PromotionReader:
  • SetSecurityProfile:
  • ShipmentAdmin:
  • ShipmentReader:
  • Shopper:
  • SpendingAccountAdmin:
  • SpendingAccountReader:
  • SupplierAdmin:
  • SupplierReader:
  • SupplierUserAdmin:
  • SupplierUserGroupAdmin:
  • SupplierUserGroupReader:
  • SupplierUserReader:
  • UnsubmittedOrderReader:
  • UserGroupAdmin:
  • UserGroupReader: