Package Exports
- ordercloud-javascript-sdk
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ordercloud-javascript-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
OrderCloud
OrderCloud - JavaScript client for OrderCloud No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0.0
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://ordercloud.io
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install OrderCloud --savegit
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --saveFor 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 main.js is your entry file):
browserify main.js > bundle.jsThen include bundle.js in the HTML pages.
Getting Started
Please follow the installation instruction and execute the following JS code:
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"
var api = new OrderCloud.AddressApi()
var buyerID = "buyerID_example"; // {String} ID of the buyer.
var address = new OrderCloud.Address(); // {Address}
api.Create(buyerID, address).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://api.ordercloud.io/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| OrderCloud.AddressApi | Create | POST /buyers/{buyerID}/addresses | |
| OrderCloud.AddressApi | Delete | DELETE /buyers/{buyerID}/addresses/{addressID} | |
| OrderCloud.AddressApi | DeleteAssignment | DELETE /buyers/{buyerID}/addresses/{addressID}/assignments | |
| OrderCloud.AddressApi | Get | GET /buyers/{buyerID}/addresses/{addressID} | |
| OrderCloud.AddressApi | List | GET /buyers/{buyerID}/addresses | |
| OrderCloud.AddressApi | ListAssignments | GET /buyers/{buyerID}/addresses/assignments | |
| OrderCloud.AddressApi | Patch | PATCH /buyers/{buyerID}/addresses/{addressID} | |
| OrderCloud.AddressApi | SaveAssignment | POST /buyers/{buyerID}/addresses/assignments | |
| OrderCloud.AddressApi | Update | PUT /buyers/{buyerID}/addresses/{addressID} | |
| OrderCloud.AdminAddressApi | Create | POST /addresses | |
| OrderCloud.AdminAddressApi | Delete | DELETE /addresses/{addressID} | |
| OrderCloud.AdminAddressApi | Get | GET /addresses/{addressID} | |
| OrderCloud.AdminAddressApi | List | GET /addresses | |
| OrderCloud.AdminAddressApi | Patch | PATCH /addresses/{addressID} | |
| OrderCloud.AdminAddressApi | Update | PUT /addresses/{addressID} | |
| OrderCloud.AdminUserApi | Create | POST /adminusers | |
| OrderCloud.AdminUserApi | Delete | DELETE /adminusers/{userID} | |
| OrderCloud.AdminUserApi | Get | GET /adminusers/{userID} | |
| OrderCloud.AdminUserApi | List | GET /adminusers | |
| OrderCloud.AdminUserApi | Patch | PATCH /adminusers/{userID} | |
| OrderCloud.AdminUserApi | Update | PUT /adminusers/{userID} | |
| OrderCloud.AdminUserGroupApi | Create | POST /usergroups | |
| OrderCloud.AdminUserGroupApi | Delete | DELETE /usergroups/{userGroupID} | |
| OrderCloud.AdminUserGroupApi | DeleteUserAssignment | DELETE /usergroups/{userGroupID}/assignments/{userID} | |
| OrderCloud.AdminUserGroupApi | Get | GET /usergroups/{userGroupID} | |
| OrderCloud.AdminUserGroupApi | List | GET /usergroups | |
| OrderCloud.AdminUserGroupApi | ListUserAssignments | GET /usergroups/assignments | |
| OrderCloud.AdminUserGroupApi | Patch | PATCH /usergroups/{userGroupID} | |
| OrderCloud.AdminUserGroupApi | SaveUserAssignment | POST /usergroups/assignments | |
| OrderCloud.AdminUserGroupApi | Update | PUT /usergroups/{userGroupID} | |
| OrderCloud.ApprovalRuleApi | Create | POST /buyers/{buyerID}/approvalrules | |
| OrderCloud.ApprovalRuleApi | Delete | DELETE /buyers/{buyerID}/approvalrules/{approvalRuleID} | |
| OrderCloud.ApprovalRuleApi | Get | GET /buyers/{buyerID}/approvalrules/{approvalRuleID} | |
| OrderCloud.ApprovalRuleApi | List | GET /buyers/{buyerID}/approvalrules | |
| OrderCloud.ApprovalRuleApi | Patch | PATCH /buyers/{buyerID}/approvalrules/{approvalRuleID} | |
| OrderCloud.ApprovalRuleApi | Update | PUT /buyers/{buyerID}/approvalrules/{approvalRuleID} | |
| OrderCloud.BuyerApi | Create | POST /buyers | |
| OrderCloud.BuyerApi | Delete | DELETE /buyers/{buyerID} | |
| OrderCloud.BuyerApi | Get | GET /buyers/{buyerID} | |
| OrderCloud.BuyerApi | List | GET /buyers | |
| OrderCloud.BuyerApi | Patch | PATCH /buyers/{buyerID} | |
| OrderCloud.BuyerApi | Update | PUT /buyers/{buyerID} | |
| OrderCloud.CatalogApi | Create | POST /catalogs | |
| OrderCloud.CatalogApi | Delete | DELETE /catalogs/{catalogID} | |
| OrderCloud.CatalogApi | DeleteAssignment | DELETE /catalogs/{catalogID}/assignments | |
| OrderCloud.CatalogApi | Get | GET /catalogs/{catalogID} | |
| OrderCloud.CatalogApi | List | GET /catalogs | |
| OrderCloud.CatalogApi | ListAssignments | GET /catalogs/assignments | |
| OrderCloud.CatalogApi | Patch | PATCH /catalogs/{catalogID} | |
| OrderCloud.CatalogApi | SaveAssignment | POST /catalogs/assignments | |
| OrderCloud.CatalogApi | Update | PUT /catalogs/{catalogID} | |
| OrderCloud.CategoryApi | Create | POST /catalogs/{catalogID}/categories | |
| OrderCloud.CategoryApi | Delete | DELETE /catalogs/{catalogID}/categories/{categoryID} | |
| OrderCloud.CategoryApi | DeleteAssignment | DELETE /catalogs/{catalogID}/categories/{categoryID}/assignments | |
| OrderCloud.CategoryApi | DeleteProductAssignment | DELETE /catalogs/{catalogID}/categories/{categoryID}/productassignments/{productID} | |
| OrderCloud.CategoryApi | Get | GET /catalogs/{catalogID}/categories/{categoryID} | |
| OrderCloud.CategoryApi | List | GET /catalogs/{catalogID}/categories | |
| OrderCloud.CategoryApi | ListAssignments | GET /catalogs/{catalogID}/categories/assignments | |
| OrderCloud.CategoryApi | ListProductAssignments | GET /catalogs/{catalogID}/categories/productassignments | |
| OrderCloud.CategoryApi | Patch | PATCH /catalogs/{catalogID}/categories/{categoryID} | |
| OrderCloud.CategoryApi | SaveAssignment | POST /catalogs/{catalogID}/categories/assignments | |
| OrderCloud.CategoryApi | SaveProductAssignment | POST /catalogs/{catalogID}/categories/productassignments | |
| OrderCloud.CategoryApi | Update | PUT /catalogs/{catalogID}/categories/{categoryID} | |
| OrderCloud.CostCenterApi | Create | POST /buyers/{buyerID}/costcenters | |
| OrderCloud.CostCenterApi | Delete | DELETE /buyers/{buyerID}/costcenters/{costCenterID} | |
| OrderCloud.CostCenterApi | DeleteAssignment | DELETE /buyers/{buyerID}/costcenters/{costCenterID}/assignments | |
| OrderCloud.CostCenterApi | Get | GET /buyers/{buyerID}/costcenters/{costCenterID} | |
| OrderCloud.CostCenterApi | List | GET /buyers/{buyerID}/costcenters | |
| OrderCloud.CostCenterApi | ListAssignments | GET /buyers/{buyerID}/costcenters/assignments | |
| OrderCloud.CostCenterApi | Patch | PATCH /buyers/{buyerID}/costcenters/{costCenterID} | |
| OrderCloud.CostCenterApi | SaveAssignment | POST /buyers/{buyerID}/costcenters/assignments | |
| OrderCloud.CostCenterApi | Update | PUT /buyers/{buyerID}/costcenters/{costCenterID} | |
| OrderCloud.CreditCardApi | Create | POST /buyers/{buyerID}/creditcards | |
| OrderCloud.CreditCardApi | Delete | DELETE /buyers/{buyerID}/creditcards/{creditCardID} | |
| OrderCloud.CreditCardApi | DeleteAssignment | DELETE /buyers/{buyerID}/creditcards/{creditCardID}/assignments | |
| OrderCloud.CreditCardApi | Get | GET /buyers/{buyerID}/creditcards/{creditCardID} | |
| OrderCloud.CreditCardApi | List | GET /buyers/{buyerID}/creditcards | |
| OrderCloud.CreditCardApi | ListAssignments | GET /buyers/{buyerID}/creditcards/assignments | |
| OrderCloud.CreditCardApi | Patch | PATCH /buyers/{buyerID}/creditcards/{creditCardID} | |
| OrderCloud.CreditCardApi | SaveAssignment | POST /buyers/{buyerID}/creditcards/assignments | |
| OrderCloud.CreditCardApi | Update | PUT /buyers/{buyerID}/creditcards/{creditCardID} | |
| OrderCloud.LineItemApi | Create | POST /buyers/{buyerID}/orders/{orderID}/lineitems | |
| OrderCloud.LineItemApi | Delete | DELETE /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} | |
| OrderCloud.LineItemApi | Get | GET /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} | |
| OrderCloud.LineItemApi | List | GET /buyers/{buyerID}/orders/{orderID}/lineitems | |
| OrderCloud.LineItemApi | Patch | PATCH /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} | |
| OrderCloud.LineItemApi | PatchShippingAddress | PATCH /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID}/shipto | |
| OrderCloud.LineItemApi | SetShippingAddress | PUT /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID}/shipto | |
| OrderCloud.LineItemApi | Update | PUT /buyers/{buyerID}/orders/{orderID}/lineitems/{lineItemID} | |
| OrderCloud.MeApi | CreateAddress | POST /me/addresses | |
| OrderCloud.MeApi | CreateCreditCard | POST /me/creditcards | |
| OrderCloud.MeApi | CreateFromTempUser | PUT /me/register | |
| OrderCloud.MeApi | DeleteAddress | DELETE /me/addresses/{addressID} | |
| OrderCloud.MeApi | DeleteCreditCard | DELETE /me/creditcards/{creditcardID} | |
| OrderCloud.MeApi | Get | GET /me | |
| OrderCloud.MeApi | GetAddress | GET /me/addresses/{addressID} | |
| OrderCloud.MeApi | GetCreditCard | GET /me/creditcards/{creditcardID} | |
| OrderCloud.MeApi | GetOrder | GET /me/orders/{orderID} | |
| OrderCloud.MeApi | GetProduct | GET /me/products/{productID} | |
| OrderCloud.MeApi | GetPromotion | GET /me/promotions/{promotionID} | |
| OrderCloud.MeApi | GetSpec | GET /me/products/{productID}/specs/{specID} | |
| OrderCloud.MeApi | GetSpendingAccount | GET /me/spendingaccounts/{spendingAccountID} | |
| OrderCloud.MeApi | ListAddresses | GET /me/addresses | |
| OrderCloud.MeApi | ListCategories | GET /me/categories | |
| OrderCloud.MeApi | ListCostCenters | GET /me/costcenters | |
| OrderCloud.MeApi | ListCreditCards | GET /me/creditcards | |
| OrderCloud.MeApi | ListIncomingOrders | GET /me/orders/incoming | |
| OrderCloud.MeApi | ListOutgoingOrders | GET /me/orders/outgoing | |
| OrderCloud.MeApi | ListProducts | GET /me/products | |
| OrderCloud.MeApi | ListPromotions | GET /me/promotions | |
| OrderCloud.MeApi | ListSpecs | GET /me/products/{productID}/specs | |
| OrderCloud.MeApi | ListSpendingAccounts | GET /me/spendingAccounts | |
| OrderCloud.MeApi | ListUserGroups | GET /me/usergroups | |
| OrderCloud.MeApi | Patch | PATCH /me | |
| OrderCloud.MeApi | PatchAddress | PATCH /me/addresses/{addressID} | |
| OrderCloud.MeApi | PatchCreditCard | PATCH /me/creditcards/{creditcardID} | |
| OrderCloud.MeApi | Update | PUT /me | |
| OrderCloud.MeApi | UpdateAddress | PUT /me/addresses/{addressID} | |
| OrderCloud.MeApi | UpdateCreditCard | PUT /me/creditcards/{creditcardID} | |
| OrderCloud.MessageSendersApi | DeleteAssignment | DELETE /MessageSenders/{messageSenderID}/assignments | |
| OrderCloud.MessageSendersApi | Get | GET /MessageSenders/{messageSenderID} | |
| OrderCloud.MessageSendersApi | List | GET /MessageSenders | |
| OrderCloud.MessageSendersApi | ListAssignments | GET /MessageSenders/assignments | |
| OrderCloud.MessageSendersApi | ListCCListenerAssignments | GET /MessageSenders/CCListenerAssignments | |
| OrderCloud.MessageSendersApi | SaveAssignment | POST /MessageSenders/assignments | |
| OrderCloud.MessageSendersApi | SaveCCListenerAssignment | POST /MessageSenders/CCListenerAssignments | |
| OrderCloud.OrderApi | AddPromotion | POST /buyers/{buyerID}/orders/{orderID}/promotions/{promoCode} | |
| OrderCloud.OrderApi | Approve | POST /buyers/{buyerID}/orders/{orderID}/approve | |
| OrderCloud.OrderApi | Cancel | POST /buyers/{buyerID}/orders/{orderID}/cancel | |
| OrderCloud.OrderApi | Create | POST /buyers/{buyerID}/orders | |
| OrderCloud.OrderApi | Decline | POST /buyers/{buyerID}/orders/{orderID}/decline | |
| OrderCloud.OrderApi | Delete | DELETE /buyers/{buyerID}/orders/{orderID} | |
| OrderCloud.OrderApi | Get | GET /buyers/{buyerID}/orders/{orderID} | |
| OrderCloud.OrderApi | ListApprovals | GET /buyers/{buyerID}/orders/{orderID}/approvals | |
| OrderCloud.OrderApi | ListEligibleApprovers | GET /buyers/{buyerID}/orders/{orderID}/eligibleapprovers | |
| OrderCloud.OrderApi | ListIncoming | GET /orders/incoming | |
| OrderCloud.OrderApi | ListOutgoing | GET /orders/outgoing | |
| OrderCloud.OrderApi | ListPromotions | GET /buyers/{buyerID}/orders/{orderID}/promotions | |
| OrderCloud.OrderApi | Patch | PATCH /buyers/{buyerID}/orders/{orderID} | |
| OrderCloud.OrderApi | PatchBillingAddress | PATCH /buyers/{buyerID}/orders/{orderID}/billto | |
| OrderCloud.OrderApi | PatchShippingAddress | PATCH /buyers/{buyerID}/orders/{orderID}/shipto | |
| OrderCloud.OrderApi | RemovePromotion | DELETE /buyers/{buyerID}/orders/{orderID}/promotions/{promoCode} | |
| OrderCloud.OrderApi | SetBillingAddress | PUT /buyers/{buyerID}/orders/{orderID}/billto | |
| OrderCloud.OrderApi | SetShippingAddress | PUT /buyers/{buyerID}/orders/{orderID}/shipto | |
| OrderCloud.OrderApi | Ship | POST /buyers/{buyerID}/orders/{orderID}/ship | |
| OrderCloud.OrderApi | Submit | POST /buyers/{buyerID}/orders/{orderID}/submit | |
| OrderCloud.OrderApi | TransferTempUserOrder | PUT /buyers/{buyerID}/orders | |
| OrderCloud.OrderApi | Update | PUT /buyers/{buyerID}/orders/{orderID} | |
| OrderCloud.PasswordResetApi | ResetPassword | PUT /password/reset/{verificationCode} | |
| OrderCloud.PasswordResetApi | SendVerificationCode | POST /password/reset | |
| OrderCloud.PaymentApi | Create | POST /buyers/{buyerID}/orders/{orderID}/payments | |
| OrderCloud.PaymentApi | CreateTransaction | POST /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions | |
| OrderCloud.PaymentApi | Delete | DELETE /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | |
| OrderCloud.PaymentApi | DeleteTransaction | DELETE /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | |
| OrderCloud.PaymentApi | Get | GET /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | |
| OrderCloud.PaymentApi | List | GET /buyers/{buyerID}/orders/{orderID}/payments | |
| OrderCloud.PaymentApi | Patch | PATCH /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | |
| OrderCloud.PaymentApi | PatchTransaction | PATCH /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | |
| OrderCloud.PaymentApi | Update | PUT /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | |
| OrderCloud.PaymentApi | UpdateTransaction | PUT /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | |
| OrderCloud.PriceScheduleApi | Create | POST /priceschedules | |
| OrderCloud.PriceScheduleApi | Delete | DELETE /priceschedules/{priceScheduleID} | |
| OrderCloud.PriceScheduleApi | DeletePriceBreak | DELETE /priceschedules/{priceScheduleID}/PriceBreaks | |
| OrderCloud.PriceScheduleApi | Get | GET /priceschedules/{priceScheduleID} | |
| OrderCloud.PriceScheduleApi | List | GET /priceschedules | |
| OrderCloud.PriceScheduleApi | Patch | PATCH /priceschedules/{priceScheduleID} | |
| OrderCloud.PriceScheduleApi | SavePriceBreak | POST /priceschedules/{priceScheduleID}/PriceBreaks | |
| OrderCloud.PriceScheduleApi | Update | PUT /priceschedules/{priceScheduleID} | |
| OrderCloud.ProductApi | Create | POST /products | |
| OrderCloud.ProductApi | Delete | DELETE /products/{productID} | |
| OrderCloud.ProductApi | DeleteAssignment | DELETE /products/{productID}/assignments/{buyerID} | |
| OrderCloud.ProductApi | GenerateVariants | POST /products/{productID}/variants/generate | |
| OrderCloud.ProductApi | Get | GET /products/{productID} | |
| OrderCloud.ProductApi | GetInventory | GET /products/{productID}/inventory | |
| OrderCloud.ProductApi | GetVariant | GET /products/{productID}/variants/{variantID} | |
| OrderCloud.ProductApi | GetVariantInventory | GET /products/{productID}/variants/inventory/{variantID} | |
| OrderCloud.ProductApi | List | GET /products | |
| OrderCloud.ProductApi | ListAssignments | GET /products/assignments | |
| OrderCloud.ProductApi | ListInventory | GET /products/inventory | |
| OrderCloud.ProductApi | ListVariantInventory | GET /products/{productID}/variants/inventory | |
| OrderCloud.ProductApi | ListVariants | GET /products/{productID}/variants | |
| OrderCloud.ProductApi | Patch | PATCH /products/{productID} | |
| OrderCloud.ProductApi | PatchVariant | PATCH /products/{productID}/variants/{variantID} | |
| OrderCloud.ProductApi | SaveAssignment | POST /products/assignments | |
| OrderCloud.ProductApi | Update | PUT /products/{productID} | |
| OrderCloud.ProductApi | UpdateInventory | PUT /products/{productID}/inventory/{inventory} | |
| OrderCloud.ProductApi | UpdateVariant | PUT /products/{productID}/variants/{variantID} | |
| OrderCloud.ProductApi | UpdateVariantInventory | PUT /products/{productID}/variants/inventory/{variantID}/{inventory} | |
| OrderCloud.PromotionApi | Create | POST /promotions | |
| OrderCloud.PromotionApi | Delete | DELETE /promotions/{promotionID} | |
| OrderCloud.PromotionApi | DeleteAssignment | DELETE /promotions/{promotionID}/assignments | |
| OrderCloud.PromotionApi | Get | GET /promotions/{promotionID} | |
| OrderCloud.PromotionApi | List | GET /promotions | |
| OrderCloud.PromotionApi | ListAssignments | GET /promotions/assignments | |
| OrderCloud.PromotionApi | Patch | PATCH /promotions/{promotionID} | |
| OrderCloud.PromotionApi | SaveAssignment | POST /promotions/assignments | |
| OrderCloud.PromotionApi | Update | PUT /promotions/{promotionID} | |
| OrderCloud.SecurityProfileApi | DeleteAssignment | DELETE /securityprofiles/{securityProfileID}/assignments | |
| OrderCloud.SecurityProfileApi | Get | GET /securityprofiles/{securityProfileID} | |
| OrderCloud.SecurityProfileApi | List | GET /securityprofiles | |
| OrderCloud.SecurityProfileApi | ListAssignments | GET /securityprofiles/assignments | |
| OrderCloud.SecurityProfileApi | SaveAssignment | POST /securityprofiles/assignments | |
| OrderCloud.ShipmentApi | Create | POST /buyers/{buyerID}/shipments | |
| OrderCloud.ShipmentApi | Delete | DELETE /buyers/{buyerID}/shipments/{shipmentID} | |
| OrderCloud.ShipmentApi | DeleteItem | DELETE /buyers/{buyerID}/shipments/{shipmentID}/items/{orderID}/{lineItemID} | |
| OrderCloud.ShipmentApi | Get | GET /buyers/{buyerID}/shipments/{shipmentID} | |
| OrderCloud.ShipmentApi | List | GET /buyers/{buyerID}/shipments | |
| OrderCloud.ShipmentApi | Patch | PATCH /buyers/{buyerID}/shipments/{shipmentID} | |
| OrderCloud.ShipmentApi | SaveItem | POST /buyers/{buyerID}/shipments/{shipmentID}/items | |
| OrderCloud.ShipmentApi | Update | PUT /buyers/{buyerID}/shipments/{shipmentID} | |
| OrderCloud.SpecApi | Create | POST /specs | |
| OrderCloud.SpecApi | CreateOption | POST /specs/{specID}/options | |
| OrderCloud.SpecApi | Delete | DELETE /specs/{specID} | |
| OrderCloud.SpecApi | DeleteOption | DELETE /specs/{specID}/options/{optionID} | |
| OrderCloud.SpecApi | DeleteProductAssignment | DELETE /specs/{specID}/productassignments/{productID} | |
| OrderCloud.SpecApi | Get | GET /specs/{specID} | |
| OrderCloud.SpecApi | GetOption | GET /specs/{specID}/options/{optionID} | |
| OrderCloud.SpecApi | List | GET /specs | |
| OrderCloud.SpecApi | ListOptions | GET /specs/{specID}/options | |
| OrderCloud.SpecApi | ListProductAssignments | GET /specs/productassignments | |
| OrderCloud.SpecApi | Patch | PATCH /specs/{specID} | |
| OrderCloud.SpecApi | PatchOption | PATCH /specs/{specID}/options/{optionID} | |
| OrderCloud.SpecApi | SaveProductAssignment | POST /specs/productassignments | |
| OrderCloud.SpecApi | Update | PUT /specs/{specID} | |
| OrderCloud.SpecApi | UpdateOption | PUT /specs/{specID}/options/{optionID} | |
| OrderCloud.SpendingAccountApi | Create | POST /buyers/{buyerID}/spendingaccounts | |
| OrderCloud.SpendingAccountApi | Delete | DELETE /buyers/{buyerID}/spendingaccounts/{spendingAccountID} | |
| OrderCloud.SpendingAccountApi | DeleteAssignment | DELETE /buyers/{buyerID}/spendingaccounts/{spendingAccountID}/assignments | |
| OrderCloud.SpendingAccountApi | Get | GET /buyers/{buyerID}/spendingaccounts/{spendingAccountID} | |
| OrderCloud.SpendingAccountApi | List | GET /buyers/{buyerID}/spendingaccounts | |
| OrderCloud.SpendingAccountApi | ListAssignments | GET /buyers/{buyerID}/spendingaccounts/assignments | |
| OrderCloud.SpendingAccountApi | Patch | PATCH /buyers/{buyerID}/spendingaccounts/{spendingAccountID} | |
| OrderCloud.SpendingAccountApi | SaveAssignment | POST /buyers/{buyerID}/spendingaccounts/assignments | |
| OrderCloud.SpendingAccountApi | Update | PUT /buyers/{buyerID}/spendingaccounts/{spendingAccountID} | |
| OrderCloud.UserApi | Create | POST /buyers/{buyerID}/users | |
| OrderCloud.UserApi | Delete | DELETE /buyers/{buyerID}/users/{userID} | |
| OrderCloud.UserApi | Get | GET /buyers/{buyerID}/users/{userID} | |
| OrderCloud.UserApi | GetAccessToken | POST /buyers/{buyerID}/users/{userID}/accesstoken | |
| OrderCloud.UserApi | List | GET /buyers/{buyerID}/users | |
| OrderCloud.UserApi | Patch | PATCH /buyers/{buyerID}/users/{userID} | |
| OrderCloud.UserApi | Update | PUT /buyers/{buyerID}/users/{userID} | |
| OrderCloud.UserGroupApi | Create | POST /buyers/{buyerID}/usergroups | |
| OrderCloud.UserGroupApi | Delete | DELETE /buyers/{buyerID}/usergroups/{userGroupID} | |
| OrderCloud.UserGroupApi | DeleteUserAssignment | DELETE /buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID} | |
| OrderCloud.UserGroupApi | Get | GET /buyers/{buyerID}/usergroups/{userGroupID} | |
| OrderCloud.UserGroupApi | List | GET /buyers/{buyerID}/usergroups | |
| OrderCloud.UserGroupApi | ListUserAssignments | GET /buyers/{buyerID}/usergroups/assignments | |
| OrderCloud.UserGroupApi | Patch | PATCH /buyers/{buyerID}/usergroups/{userGroupID} | |
| OrderCloud.UserGroupApi | SaveUserAssignment | POST /buyers/{buyerID}/usergroups/assignments | |
| OrderCloud.UserGroupApi | Update | PUT /buyers/{buyerID}/usergroups/{userGroupID} |
Documentation for Models
- OrderCloud.AccessToken
- OrderCloud.Address
- OrderCloud.AddressAssignment
- OrderCloud.AdminCompany
- OrderCloud.ApprovalRule
- OrderCloud.BaseSpec
- OrderCloud.Buyer
- OrderCloud.BuyerAddress
- OrderCloud.BuyerCreditCard
- OrderCloud.BuyerProduct
- OrderCloud.BuyerSpec
- OrderCloud.Catalog
- OrderCloud.CatalogAssignment
- OrderCloud.Category
- OrderCloud.CategoryAssignment
- OrderCloud.CategoryProductAssignment
- OrderCloud.CostCenter
- OrderCloud.CostCenterAssignment
- OrderCloud.CreditCard
- OrderCloud.CreditCardAssignment
- OrderCloud.ImpersonateTokenRequest
- OrderCloud.Inventory
- OrderCloud.LineItem
- OrderCloud.LineItemProduct
- OrderCloud.LineItemSpec
- OrderCloud.ListAddress
- OrderCloud.ListAddressAssignment
- OrderCloud.ListAdminCompany
- OrderCloud.ListApprovalRule
- OrderCloud.ListBuyer
- OrderCloud.ListBuyerAddress
- OrderCloud.ListBuyerCreditCard
- OrderCloud.ListBuyerProduct
- OrderCloud.ListBuyerSpec
- OrderCloud.ListCatalog
- OrderCloud.ListCatalogAssignment
- OrderCloud.ListCategory
- OrderCloud.ListCategoryAssignment
- OrderCloud.ListCategoryProductAssignment
- OrderCloud.ListCostCenter
- OrderCloud.ListCostCenterAssignment
- OrderCloud.ListCreditCard
- OrderCloud.ListCreditCardAssignment
- OrderCloud.ListInventory
- OrderCloud.ListLineItem
- OrderCloud.ListMessageCCListenerAssignment
- OrderCloud.ListMessageConfig
- OrderCloud.ListMessageSender
- OrderCloud.ListMessageSenderAssignment
- OrderCloud.ListNativeIntegrationProxyAssignment
- OrderCloud.ListNativeIntegrtionProxyConfig
- OrderCloud.ListOrder
- OrderCloud.ListOrderApproval
- OrderCloud.ListOrderPromotion
- OrderCloud.ListPayment
- OrderCloud.ListPriceSchedule
- OrderCloud.ListProduct
- OrderCloud.ListProductAssignment
- OrderCloud.ListPromotion
- OrderCloud.ListPromotionAssignment
- OrderCloud.ListSecurityProfile
- OrderCloud.ListSecurityProfileAssignment
- OrderCloud.ListShipment
- OrderCloud.ListSpec
- OrderCloud.ListSpecOption
- OrderCloud.ListSpecProductAssignment
- OrderCloud.ListSpendingAccount
- OrderCloud.ListSpendingAccountAssignment
- OrderCloud.ListUser
- OrderCloud.ListUserGroup
- OrderCloud.ListUserGroupAssignment
- OrderCloud.ListVariant
- OrderCloud.ListWebHook
- OrderCloud.ListWebHookRoute
- OrderCloud.ListXpIndex
- OrderCloud.MessageCCListenerAssignment
- OrderCloud.MessageConfig
- OrderCloud.MessageSender
- OrderCloud.MessageSenderAssignment
- OrderCloud.Meta
- OrderCloud.NativeIntegrationProxyAssignment
- OrderCloud.NativeIntegrtionProxyConfig
- OrderCloud.Order
- OrderCloud.OrderApproval
- OrderCloud.OrderPromotion
- OrderCloud.PasswordReset
- OrderCloud.PasswordResetRequest
- OrderCloud.Payment
- OrderCloud.PaymentTransaction
- OrderCloud.PingResponse
- OrderCloud.PriceBreak
- OrderCloud.PriceSchedule
- OrderCloud.Product
- OrderCloud.ProductAssignment
- OrderCloud.Promotion
- OrderCloud.PromotionAssignment
- OrderCloud.SecurityProfile
- OrderCloud.SecurityProfileAssignment
- OrderCloud.Shipment
- OrderCloud.ShipmentItem
- OrderCloud.Spec
- OrderCloud.SpecOption
- OrderCloud.SpecProductAssignment
- OrderCloud.SpendingAccount
- OrderCloud.SpendingAccountAssignment
- OrderCloud.StripeCreditCard
- OrderCloud.Usage
- OrderCloud.UsageBuyer
- OrderCloud.UsageOrganization
- OrderCloud.User
- OrderCloud.UserGroup
- OrderCloud.UserGroupAssignment
- OrderCloud.Variant
- OrderCloud.WebHook
- OrderCloud.WebHookRoute
- OrderCloud.XpIndex
Documentation for Authorization
oauth2
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes:
- AddressAdmin:
- AddressReader:
- AdminUserAdmin:
- AdminUserGroupAdmin:
- AdminUserGroupReader:
- AdminUserReader:
- ApprovalRuleAdmin:
- ApprovalRuleReader:
- BuyerAdmin:
- BuyerReader:
- BuyerUserAdmin:
- BuyerUserReader:
- CatalogAdmin:
- CatalogReader:
- CategoryAdmin:
- CategoryReader:
- CostCenterAdmin:
- CostCenterReader:
- CreditCardAdmin:
- CreditCardReader:
- DevCenter:
- DevCenterImpersonate:
- DevCenterMessageConfigAdmin:
- DevCenterPasswordReset:
- FullAccess:
- GrantForAnyRole:
- InventoryAdmin:
- MeAddressAdmin:
- MeAdmin:
- MeCreditCardAdmin:
- MessageConfigAssignmentAdmin:
- MeXpAdmin:
- OrderAdmin:
- OrderReader:
- OverrideShipping:
- OverrideTax:
- OverrideUnitPrice:
- PermissionAdmin:
- PriceScheduleAdmin:
- PriceScheduleReader:
- ProductAdmin:
- ProductAssignmentAdmin:
- ProductReader:
- PromotionAdmin:
- PromotionReader:
- SpendingAccountAdmin:
- SpendingAccountReader:
- UnsubmittedOrderReader:
- UserGroupAdmin:
- UserGroupReader: