order_cloud
Introduction
OrderCloud gem is an SDK for OrderCloud's API written in Ruby. All of the methods for the most part are a 1:1 reflection of the API. This guide will cover how to install and get started with OrderCloud Ruby gem. OrderCloud - the Ruby gem for the OrderCloud
Acknowledgment
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0.57
- Build date: 2017-06-22T13:21:37.599-05:00
- Build package: io.swagger.codegen.languages.RubyClientCodegen
For more information, please visit http://ordercloud.io
Requirements
- Ruby >= 2.3.0
Installation
Add this line to your Gemfile
:
gem 'order_cloud', '~> 1.0.57'
Or run this in your terminal:
gem install order_cloud
Configuration
You will need to provide the ClientID which identifies the Organization or Buyer Company you will be interacting with. The ClientID can be found in the application tab of your Dashboard. Check out this guide for more information. Once you have the ClientID you can configure it with the following function.
# Load the gem
require 'order_cloud'
# Setup authorization
OrderCloud.configure do |config|
config.client_id = 'MY_CLIENT_ID'
config.scopes= ['MY_SCOPE']
end
Authentication
OrderCloud::ApiAuth::login('username', 'password')
Impersonation
user_instance = OrderCloud::UserApi.new
impersonation_token = user_instance.get_access_token(buyer_id, user_id, { :claims => ['YOUR_CLAIM'] })
OrderCloud::ApiAuth::start_impersonate(impersonation_token)
puts 'Impersonation status: #{ OrderCloud::Configuration.default.impersonating?}'
OrderCloud::ApiAuth::stop_impersonate
puts 'Impersonation status: #{ OrderCloud::Configuration.default.impersonating?}'
Example
api_instance = OrderCloud::ProductApi.new
begin
result = api_instance.list
p result
rescue OrderCloud::ApiError => e
puts "Exception when calling ProductApi->list: #{e}"
end
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 | delete_assignment | DELETE /buyers/buyerID/addresses/addressID/assignments | |
OrderCloud::AddressApi | get | GET /buyers/buyerID/addresses/addressID | |
OrderCloud::AddressApi | list | GET /buyers/buyerID/addresses | |
OrderCloud::AddressApi | list_assignments | GET /buyers/buyerID/addresses/assignments | |
OrderCloud::AddressApi | patch | PATCH /buyers/buyerID/addresses/addressID | |
OrderCloud::AddressApi | save_assignment | 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 | delete_user_assignment | DELETE /usergroups/userGroupID/assignments/userID | |
OrderCloud::AdminUserGroupApi | get | GET /usergroups/userGroupID | |
OrderCloud::AdminUserGroupApi | list | GET /usergroups | |
OrderCloud::AdminUserGroupApi | list_user_assignments | GET /usergroups/assignments | |
OrderCloud::AdminUserGroupApi | patch | PATCH /usergroups/userGroupID | |
OrderCloud::AdminUserGroupApi | save_user_assignment | 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 | delete_assignment | DELETE /catalogs/catalogID/assignments | |
OrderCloud::CatalogApi | delete_product_assignment | DELETE /catalogs/catalogID/productassignments/productID | |
OrderCloud::CatalogApi | get | GET /catalogs/catalogID | |
OrderCloud::CatalogApi | list | GET /catalogs | |
OrderCloud::CatalogApi | list_assignments | GET /catalogs/assignments | |
OrderCloud::CatalogApi | list_product_assignments | GET /catalogs/productassignments | |
OrderCloud::CatalogApi | patch | PATCH /catalogs/catalogID | |
OrderCloud::CatalogApi | save_assignment | POST /catalogs/assignments | |
OrderCloud::CatalogApi | save_product_assignment | POST /catalogs/productassignments | |
OrderCloud::CatalogApi | update | PUT /catalogs/catalogID | |
OrderCloud::CategoryApi | create | POST /catalogs/catalogID/categories | |
OrderCloud::CategoryApi | delete | DELETE /catalogs/catalogID/categories/categoryID | |
OrderCloud::CategoryApi | delete_assignment | DELETE /catalogs/catalogID/categories/categoryID/assignments | |
OrderCloud::CategoryApi | delete_product_assignment | DELETE /catalogs/catalogID/categories/categoryID/productassignments/productID | |
OrderCloud::CategoryApi | get | GET /catalogs/catalogID/categories/categoryID | |
OrderCloud::CategoryApi | list | GET /catalogs/catalogID/categories | |
OrderCloud::CategoryApi | list_assignments | GET /catalogs/catalogID/categories/assignments | |
OrderCloud::CategoryApi | list_product_assignments | GET /catalogs/catalogID/categories/productassignments | |
OrderCloud::CategoryApi | patch | PATCH /catalogs/catalogID/categories/categoryID | |
OrderCloud::CategoryApi | save_assignment | POST /catalogs/catalogID/categories/assignments | |
OrderCloud::CategoryApi | save_product_assignment | 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 | delete_assignment | DELETE /buyers/buyerID/costcenters/costCenterID/assignments | |
OrderCloud::CostCenterApi | get | GET /buyers/buyerID/costcenters/costCenterID | |
OrderCloud::CostCenterApi | list | GET /buyers/buyerID/costcenters | |
OrderCloud::CostCenterApi | list_assignments | GET /buyers/buyerID/costcenters/assignments | |
OrderCloud::CostCenterApi | patch | PATCH /buyers/buyerID/costcenters/costCenterID | |
OrderCloud::CostCenterApi | save_assignment | 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 | delete_assignment | DELETE /buyers/buyerID/creditcards/creditCardID/assignments | |
OrderCloud::CreditCardApi | get | GET /buyers/buyerID/creditcards/creditCardID | |
OrderCloud::CreditCardApi | list | GET /buyers/buyerID/creditcards | |
OrderCloud::CreditCardApi | list_assignments | GET /buyers/buyerID/creditcards/assignments | |
OrderCloud::CreditCardApi | patch | PATCH /buyers/buyerID/creditcards/creditCardID | |
OrderCloud::CreditCardApi | save_assignment | POST /buyers/buyerID/creditcards/assignments | |
OrderCloud::CreditCardApi | update | PUT /buyers/buyerID/creditcards/creditCardID | |
OrderCloud::ImpersonationConfigApi | create | POST /impersonationconfig | |
OrderCloud::ImpersonationConfigApi | delete | DELETE /impersonationconfig/impersonationConfigID | |
OrderCloud::ImpersonationConfigApi | get | GET /impersonationconfig/impersonationConfigID | |
OrderCloud::ImpersonationConfigApi | list | GET /impersonationconfig | |
OrderCloud::ImpersonationConfigApi | patch | PATCH /impersonationconfig/impersonationConfigID | |
OrderCloud::ImpersonationConfigApi | update | PUT /impersonationconfig/impersonationConfigID | |
OrderCloud::LineItemApi | create | POST /orders/direction/orderID/lineitems | |
OrderCloud::LineItemApi | delete | DELETE /orders/direction/orderID/lineitems/lineItemID | |
OrderCloud::LineItemApi | get | GET /orders/direction/orderID/lineitems/lineItemID | |
OrderCloud::LineItemApi | list | GET /orders/direction/orderID/lineitems | |
OrderCloud::LineItemApi | patch | PATCH /orders/direction/orderID/lineitems/lineItemID | |
OrderCloud::LineItemApi | patch_shipping_address | PATCH /orders/direction/orderID/lineitems/lineItemID/shipto | |
OrderCloud::LineItemApi | set_shipping_address | PUT /orders/direction/orderID/lineitems/lineItemID/shipto | |
OrderCloud::LineItemApi | update | PUT /orders/direction/orderID/lineitems/lineItemID | |
OrderCloud::MeApi | create_address | POST /me/addresses | |
OrderCloud::MeApi | create_credit_card | POST /me/creditcards | |
OrderCloud::MeApi | delete_address | DELETE /me/addresses/addressID | |
OrderCloud::MeApi | delete_credit_card | DELETE /me/creditcards/creditcardID | |
OrderCloud::MeApi | get | GET /me | |
OrderCloud::MeApi | get_address | GET /me/addresses/addressID | |
OrderCloud::MeApi | get_catalog | GET /me/catalogs/catalogID | |
OrderCloud::MeApi | get_credit_card | GET /me/creditcards/creditcardID | |
OrderCloud::MeApi | get_product | GET /me/products/productID | |
OrderCloud::MeApi | get_promotion | GET /me/promotions/promotionID | |
OrderCloud::MeApi | get_shipment | GET /me/shipments/shipmentID | |
OrderCloud::MeApi | get_spec | GET /me/products/productID/specs/specID | |
OrderCloud::MeApi | get_spending_account | GET /me/spendingaccounts/spendingAccountID | |
OrderCloud::MeApi | list_addresses | GET /me/addresses | |
OrderCloud::MeApi | list_approvable_orders | GET /me/orders/approvable | |
OrderCloud::MeApi | list_catalogs | GET /me/catalogs | |
OrderCloud::MeApi | list_categories | GET /me/categories | |
OrderCloud::MeApi | list_cost_centers | GET /me/costcenters | |
OrderCloud::MeApi | list_credit_cards | GET /me/creditcards | |
OrderCloud::MeApi | list_orders | GET /me/orders | |
OrderCloud::MeApi | list_products | GET /me/products | |
OrderCloud::MeApi | list_promotions | GET /me/promotions | |
OrderCloud::MeApi | list_shipment_items | GET /me/shipments/shipmentID/items | |
OrderCloud::MeApi | list_shipments | GET /me/shipments | |
OrderCloud::MeApi | list_specs | GET /me/products/productID/specs | |
OrderCloud::MeApi | list_spending_accounts | GET /me/spendingAccounts | |
OrderCloud::MeApi | list_user_groups | GET /me/usergroups | |
OrderCloud::MeApi | patch | PATCH /me | |
OrderCloud::MeApi | patch_address | PATCH /me/addresses/addressID | |
OrderCloud::MeApi | patch_credit_card | PATCH /me/creditcards/creditcardID | |
OrderCloud::MeApi | register | PUT /me/register | |
OrderCloud::MeApi | reset_password_by_token | POST /me/password | |
OrderCloud::MeApi | transfer_anon_user_order | PUT /me/orders | |
OrderCloud::MeApi | update | PUT /me | |
OrderCloud::MeApi | update_address | PUT /me/addresses/addressID | |
OrderCloud::MeApi | update_credit_card | PUT /me/creditcards/creditcardID | |
OrderCloud::MessageSendersApi | delete_assignment | DELETE /messagesenders/messageSenderID/assignments | |
OrderCloud::MessageSendersApi | get | GET /messagesenders/messageSenderID | |
OrderCloud::MessageSendersApi | list | GET /messagesenders | |
OrderCloud::MessageSendersApi | list_assignments | GET /messagesenders/assignments | |
OrderCloud::MessageSendersApi | list_cc_listener_assignments | GET /messagesenders/CCListenerAssignments | |
OrderCloud::MessageSendersApi | save_assignment | POST /messagesenders/assignments | |
OrderCloud::MessageSendersApi | save_cc_listener_assignment | POST /messagesenders/CCListenerAssignments | |
OrderCloud::OrderApi | add_promotion | POST /orders/direction/orderID/promotions/promoCode | |
OrderCloud::OrderApi | approve | POST /orders/direction/orderID/approve | |
OrderCloud::OrderApi | cancel | POST /orders/direction/orderID/cancel | |
OrderCloud::OrderApi | create | POST /orders/direction | |
OrderCloud::OrderApi | decline | POST /orders/direction/orderID/decline | |
OrderCloud::OrderApi | delete | DELETE /orders/direction/orderID | |
OrderCloud::OrderApi | get | GET /orders/direction/orderID | |
OrderCloud::OrderApi | list | GET /orders/direction | |
OrderCloud::OrderApi | list_approvals | GET /orders/direction/orderID/approvals | |
OrderCloud::OrderApi | list_eligible_approvers | GET /orders/direction/orderID/eligibleapprovers | |
OrderCloud::OrderApi | list_promotions | GET /orders/direction/orderID/promotions | |
OrderCloud::OrderApi | patch | PATCH /orders/direction/orderID | |
OrderCloud::OrderApi | patch_billing_address | PATCH /orders/direction/orderID/billto | |
OrderCloud::OrderApi | patch_shipping_address | PATCH /orders/direction/orderID/shipto | |
OrderCloud::OrderApi | remove_promotion | DELETE /orders/direction/orderID/promotions/promoCode | |
OrderCloud::OrderApi | set_billing_address | PUT /orders/direction/orderID/billto | |
OrderCloud::OrderApi | set_shipping_address | PUT /orders/direction/orderID/shipto | |
OrderCloud::OrderApi | ship | POST /orders/direction/orderID/ship | |
OrderCloud::OrderApi | submit | POST /orders/direction/orderID/submit | |
OrderCloud::OrderApi | update | PUT /orders/direction/orderID | |
OrderCloud::PasswordResetApi | reset_password_by_verification_code | PUT /password/reset/verificationCode | |
OrderCloud::PasswordResetApi | send_verification_code | POST /password/reset | |
OrderCloud::PaymentApi | create | POST /orders/direction/orderID/payments | |
OrderCloud::PaymentApi | create_transaction | POST /orders/direction/orderID/payments/paymentID/transactions | |
OrderCloud::PaymentApi | delete | DELETE /orders/direction/orderID/payments/paymentID | |
OrderCloud::PaymentApi | delete_transaction | DELETE /orders/direction/orderID/payments/paymentID/transactions/transactionID | |
OrderCloud::PaymentApi | get | GET /orders/direction/orderID/payments/paymentID | |
OrderCloud::PaymentApi | list | GET /orders/direction/orderID/payments | |
OrderCloud::PaymentApi | patch | PATCH /orders/direction/orderID/payments/paymentID | |
OrderCloud::PriceScheduleApi | create | POST /priceschedules | |
OrderCloud::PriceScheduleApi | delete | DELETE /priceschedules/priceScheduleID | |
OrderCloud::PriceScheduleApi | delete_price_break | DELETE /priceschedules/priceScheduleID/PriceBreaks | |
OrderCloud::PriceScheduleApi | get | GET /priceschedules/priceScheduleID | |
OrderCloud::PriceScheduleApi | list | GET /priceschedules | |
OrderCloud::PriceScheduleApi | patch | PATCH /priceschedules/priceScheduleID | |
OrderCloud::PriceScheduleApi | save_price_break | POST /priceschedules/priceScheduleID/PriceBreaks | |
OrderCloud::PriceScheduleApi | update | PUT /priceschedules/priceScheduleID | |
OrderCloud::ProductApi | create | POST /products | |
OrderCloud::ProductApi | delete | DELETE /products/productID | |
OrderCloud::ProductApi | delete_assignment | DELETE /products/productID/assignments/buyerID | |
OrderCloud::ProductApi | generate_variants | POST /products/productID/variants/generate | |
OrderCloud::ProductApi | get | GET /products/productID | |
OrderCloud::ProductApi | get_variant | GET /products/productID/variants/variantID | |
OrderCloud::ProductApi | list | GET /products | |
OrderCloud::ProductApi | list_assignments | GET /products/assignments | |
OrderCloud::ProductApi | list_suppliers | GET /products/productID/suppliers | |
OrderCloud::ProductApi | list_variants | GET /products/productID/variants | |
OrderCloud::ProductApi | patch | PATCH /products/productID | |
OrderCloud::ProductApi | patch_variant | PATCH /products/productID/variants/variantID | |
OrderCloud::ProductApi | remove_supplier | DELETE /products/productID/suppliers/supplierID | |
OrderCloud::ProductApi | save_assignment | POST /products/assignments | |
OrderCloud::ProductApi | save_supplier | PUT /products/productID/suppliers/supplierID | |
OrderCloud::ProductApi | update | PUT /products/productID | |
OrderCloud::ProductApi | update_variant | PUT /products/productID/variants/variantID | |
OrderCloud::PromotionApi | create | POST /promotions | |
OrderCloud::PromotionApi | delete | DELETE /promotions/promotionID | |
OrderCloud::PromotionApi | delete_assignment | DELETE /promotions/promotionID/assignments | |
OrderCloud::PromotionApi | get | GET /promotions/promotionID | |
OrderCloud::PromotionApi | list | GET /promotions | |
OrderCloud::PromotionApi | list_assignments | GET /promotions/assignments | |
OrderCloud::PromotionApi | patch | PATCH /promotions/promotionID | |
OrderCloud::PromotionApi | save_assignment | POST /promotions/assignments | |
OrderCloud::PromotionApi | update | PUT /promotions/promotionID | |
OrderCloud::SecurityProfileApi | delete_assignment | DELETE /securityprofiles/securityProfileID/assignments | |
OrderCloud::SecurityProfileApi | get | GET /securityprofiles/securityProfileID | |
OrderCloud::SecurityProfileApi | list | GET /securityprofiles | |
OrderCloud::SecurityProfileApi | list_assignments | GET /securityprofiles/assignments | |
OrderCloud::SecurityProfileApi | save_assignment | POST /securityprofiles/assignments | |
OrderCloud::ShipmentApi | create | POST /shipments | |
OrderCloud::ShipmentApi | delete | DELETE /shipments/shipmentID | |
OrderCloud::ShipmentApi | delete_item | DELETE /shipments/shipmentID/items/orderID/lineItemID | |
OrderCloud::ShipmentApi | get | GET /shipments/shipmentID | |
OrderCloud::ShipmentApi | get_item | GET /shipments/shipmentID/items/orderID/lineItemID | |
OrderCloud::ShipmentApi | list | GET /shipments | |
OrderCloud::ShipmentApi | list_items | GET /shipments/shipmentID/items | |
OrderCloud::ShipmentApi | patch | PATCH /shipments/shipmentID | |
OrderCloud::ShipmentApi | save_item | POST /shipments/shipmentID/items | |
OrderCloud::ShipmentApi | update | PUT /shipments/shipmentID | |
OrderCloud::SpecApi | create | POST /specs | |
OrderCloud::SpecApi | create_option | POST /specs/specID/options | |
OrderCloud::SpecApi | delete | DELETE /specs/specID | |
OrderCloud::SpecApi | delete_option | DELETE /specs/specID/options/optionID | |
OrderCloud::SpecApi | delete_product_assignment | DELETE /specs/specID/productassignments/productID | |
OrderCloud::SpecApi | get | GET /specs/specID | |
OrderCloud::SpecApi | get_option | GET /specs/specID/options/optionID | |
OrderCloud::SpecApi | list | GET /specs | |
OrderCloud::SpecApi | list_options | GET /specs/specID/options | |
OrderCloud::SpecApi | list_product_assignments | GET /specs/productassignments | |
OrderCloud::SpecApi | patch | PATCH /specs/specID | |
OrderCloud::SpecApi | patch_option | PATCH /specs/specID/options/optionID | |
OrderCloud::SpecApi | save_product_assignment | POST /specs/productassignments | |
OrderCloud::SpecApi | update | PUT /specs/specID | |
OrderCloud::SpecApi | update_option | PUT /specs/specID/options/optionID | |
OrderCloud::SpendingAccountApi | create | POST /buyers/buyerID/spendingaccounts | |
OrderCloud::SpendingAccountApi | delete | DELETE /buyers/buyerID/spendingaccounts/spendingAccountID | |
OrderCloud::SpendingAccountApi | delete_assignment | DELETE /buyers/buyerID/spendingaccounts/spendingAccountID/assignments | |
OrderCloud::SpendingAccountApi | get | GET /buyers/buyerID/spendingaccounts/spendingAccountID | |
OrderCloud::SpendingAccountApi | list | GET /buyers/buyerID/spendingaccounts | |
OrderCloud::SpendingAccountApi | list_assignments | GET /buyers/buyerID/spendingaccounts/assignments | |
OrderCloud::SpendingAccountApi | patch | PATCH /buyers/buyerID/spendingaccounts/spendingAccountID | |
OrderCloud::SpendingAccountApi | save_assignment | POST /buyers/buyerID/spendingaccounts/assignments | |
OrderCloud::SpendingAccountApi | update | PUT /buyers/buyerID/spendingaccounts/spendingAccountID | |
OrderCloud::SupplierApi | create | POST /suppliers | |
OrderCloud::SupplierApi | delete | DELETE /suppliers/supplierID | |
OrderCloud::SupplierApi | get | GET /suppliers/supplierID | |
OrderCloud::SupplierApi | list | GET /suppliers | |
OrderCloud::SupplierApi | patch | PATCH /suppliers/supplierID | |
OrderCloud::SupplierApi | update | PUT /suppliers/supplierID | |
OrderCloud::SupplierUserApi | create | POST /suppliers/supplierID/users | |
OrderCloud::SupplierUserApi | delete | DELETE /suppliers/supplierID/users/userID | |
OrderCloud::SupplierUserApi | get | GET /suppliers/supplierID/users/userID | |
OrderCloud::SupplierUserApi | get_access_token | POST /suppliers/supplierID/users/userID/accesstoken | |
OrderCloud::SupplierUserApi | list | GET /suppliers/supplierID/users | |
OrderCloud::SupplierUserApi | patch | PATCH /suppliers/supplierID/users/userID | |
OrderCloud::SupplierUserApi | update | PUT /suppliers/supplierID/users/userID | |
OrderCloud::SupplierUserGroupApi | create | POST /suppliers/supplierID/usergroups | |
OrderCloud::SupplierUserGroupApi | delete | DELETE /suppliers/supplierID/usergroups/userGroupID | |
OrderCloud::SupplierUserGroupApi | delete_user_assignment | DELETE /suppliers/supplierID/usergroups/userGroupID/assignments/userID | |
OrderCloud::SupplierUserGroupApi | get | GET /suppliers/supplierID/usergroups/userGroupID | |
OrderCloud::SupplierUserGroupApi | list | GET /suppliers/supplierID/usergroups | |
OrderCloud::SupplierUserGroupApi | list_user_assignments | GET /suppliers/supplierID/usergroups/assignments | |
OrderCloud::SupplierUserGroupApi | patch | PATCH /suppliers/supplierID/usergroups/userGroupID | |
OrderCloud::SupplierUserGroupApi | save_user_assignment | POST /suppliers/supplierID/usergroups/assignments | |
OrderCloud::SupplierUserGroupApi | update | PUT /suppliers/supplierID/usergroups/userGroupID | |
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 | get_access_token | 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 | delete_user_assignment | DELETE /buyers/buyerID/usergroups/userGroupID/assignments/userID | |
OrderCloud::UserGroupApi | get | GET /buyers/buyerID/usergroups/userGroupID | |
OrderCloud::UserGroupApi | list | GET /buyers/buyerID/usergroups | |
OrderCloud::UserGroupApi | list_user_assignments | GET /buyers/buyerID/usergroups/assignments | |
OrderCloud::UserGroupApi | patch | PATCH /buyers/buyerID/usergroups/userGroupID | |
OrderCloud::UserGroupApi | save_user_assignment | POST /buyers/buyerID/usergroups/assignments | |
OrderCloud::UserGroupApi | 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: