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: 3.3.3
• Build date: 2019-06-05T11:37:49.175-05:00

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

Installation

npm

npm install ordercloud-javascript-sdk --save

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.Sdk.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(response => {
    //store token, now any subsequent calls will automatically set this token in the headers for you
    defaultClient.authentications['oauth2'].accessToken = token;
  })
  .catch(err => 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(user => console.log("This user's name is " + user.FirstName + " " + user.LastName))

Filtering

All of the filtering options you love from the API are available through the SDK as well. Simply pass in a key/value pair to the filters object on list calls where the key is any top-level API model or a custom indexed xp value and the value is the value you'd like to filter on.

Let's run through a couple scenarios and what the call will look like with the SDK:

My products where xp.Featured is true

return OrderCloudSDK.Me.ListProducts({filters: {'xp.Featured': true})
  .then(productList => console.log(productList));

My orders submitted after April 20th, 2018

return OrderCloudSDK.Me.ListOrders( {filters: {DateSubmitted: '>2018-04-20'}})
  .then(orderList => console.log(orderList))

Users with the last name starting with Smith:

return OrderCloudSDK.Users.List('my-mock-buyerid', {filters: {LastName: 'Smith*'})
  .then(userList => console.log(userList));

Users with the last name starting with Smith or users with the last name ending with Jones

return OrderCloudSDK.Users.List('my-mock-buyerid', {filters: {LastName: 'Smith*|*Jones'}})
  .then(userList => console.log(userList));

Products where xp.Color is not red and not blue

return OrderCloudSDK.Products.List({filters: {'xp.Color': ['!red', '!blue']}});

And of course you can mix and match filters to your heart's content.

Impersonation

Impersonation allows a seller user to make an api call on behalf of another user. The SDK enables this in two different ways, both tackling different use cases.

The first method we'll talk about is best suited when you need to toggle between just two users during a session. You'll simply get an impersonation token, set it and then use the As() method to flag the SDK that you want to use the impersonated token.

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

// set regular token
var myToken = 'YOUR_TOKEN';
defaultClient.authentications['oauth2'].accessToken = myToken;

// set impersonation token
var myImpersonationToken = 'YOUR_IMPERSONATED_TOKEN'
defaultClient.authentications['oauth2'].impersonationToken = myImpersonationToken;

// Get products for regular user
OrderCloudSDK.As().Me.ListProducts()
  .then(productList => console.log(productList))


// Get products for the impersonated user
OrderCloudSDK.As().Me.ListProducts()
  .then(impersonatedProductList => console.log(impersonatedProductList))

As you can see this method makes it very easy to toggle between impersonated calls and non-impersonated calls. But what if you have more than two tokens to toggle between? To address that scenario we recommend using the optional accessToken parameter available on all calls.

var OrderCloud = require('ordercloud-javascript-sdk')
var token1 = 'USER1_TOKEN';
var token2 = 'USER2_TOKEN';
var token3 = 'USER3_TOKEN';

// Get products for user 1
OrderCloudSDK.As(null, token1).Me.ListProducts()
  .then(user1ProductList => console.log(user1ProductList))

// Get products for user 2
OrderCloudSDK.As(null, token2).Me.ListProducts()
  .then(user2ProductList => console.log(user2ProductList))

// Get products for user 3
OrderCloudSDK.As(null, token3).Me.ListProducts()
  .then(user3ProductList => console.log(user3ProductList))

Please note that the parameter for accessToken will always be the last parameter. We are setting the options object to null since we don't want to pass along any options with this request, and the accessToken parameter is defined after the options object.

Typescript Support

This package is fully compatible with typescript and comes bundles with its own definition files. Using this with typescript couldn't be easier!

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

Documentation for Models

• OrderCloud.AccessToken
• OrderCloud.Address
• OrderCloud.AddressAssignment
• OrderCloud.ApiClient
• OrderCloud.ApiClientAssignment
• OrderCloud.ApprovalRule
• 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.ImpersonationConfig
• OrderCloud.Incrementor
• OrderCloud.Inventory
• OrderCloud.LineItem
• OrderCloud.LineItemProduct
• OrderCloud.LineItemSpec
• OrderCloud.LineItemVariant
• OrderCloud.ListAddress
• OrderCloud.ListAddressAssignment
• OrderCloud.ListApiClient
• OrderCloud.ListApiClientAssignment
• 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.ListFacet
• OrderCloud.ListFacetValue
• OrderCloud.ListImpersonationConfig
• OrderCloud.ListIncrementor
• OrderCloud.ListLineItem
• OrderCloud.ListMessageCCListenerAssignment
• OrderCloud.ListMessageSender
• OrderCloud.ListMessageSenderAssignment
• OrderCloud.ListOpenIdConnect
• OrderCloud.ListOrder
• OrderCloud.ListOrderApproval
• OrderCloud.ListOrderPromotion
• OrderCloud.ListPayment
• OrderCloud.ListPriceSchedule
• OrderCloud.ListProduct
• OrderCloud.ListProductAssignment
• OrderCloud.ListProductCatalogAssignment
• OrderCloud.ListProductFacet
• 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.MeSupplier
• OrderCloud.MeUser
• OrderCloud.MessageCCListenerAssignment
• OrderCloud.MessageSender
• OrderCloud.MessageSenderAssignment
• OrderCloud.Meta
• OrderCloud.MetaWithFacets
• OrderCloud.OpenIdConnect
• OrderCloud.Order
• OrderCloud.OrderApproval
• OrderCloud.OrderApprovalInfo
• OrderCloud.OrderPromotion
• OrderCloud.PartialAddress
• OrderCloud.PartialApiClient
• OrderCloud.PartialApprovalRule
• OrderCloud.PartialBuyer
• OrderCloud.PartialBuyerAddress
• OrderCloud.PartialBuyerCreditCard
• OrderCloud.PartialCatalog
• OrderCloud.PartialCategory
• OrderCloud.PartialCostCenter
• OrderCloud.PartialCreditCard
• OrderCloud.PartialImpersonationConfig
• OrderCloud.PartialIncrementor
• OrderCloud.PartialInventory
• OrderCloud.PartialLineItem
• OrderCloud.PartialLineItemProduct
• OrderCloud.PartialLineItemSpec
• OrderCloud.PartialLineItemVariant
• OrderCloud.PartialMeBuyer
• OrderCloud.PartialMeSupplier
• OrderCloud.PartialMeUser
• OrderCloud.PartialMessageSender
• OrderCloud.PartialOpenIdConnect
• OrderCloud.PartialOrder
• OrderCloud.PartialPayment
• OrderCloud.PartialPaymentTransaction
• OrderCloud.PartialPriceBreak
• OrderCloud.PartialPriceSchedule
• OrderCloud.PartialProduct
• OrderCloud.PartialProductFacet
• OrderCloud.PartialPromotion
• OrderCloud.PartialShipment
• OrderCloud.PartialSpec
• OrderCloud.PartialSpecOption
• OrderCloud.PartialSpendingAccount
• OrderCloud.PartialSupplier
• OrderCloud.PartialUser
• OrderCloud.PartialUserGroup
• OrderCloud.PartialVariant
• OrderCloud.PartialVariantInventory
• OrderCloud.PasswordReset
• OrderCloud.PasswordResetRequest
• OrderCloud.Payment
• OrderCloud.PaymentTransaction
• OrderCloud.PriceBreak
• OrderCloud.PriceSchedule
• OrderCloud.Product
• OrderCloud.ProductAssignment
• OrderCloud.ProductCatalogAssignment
• OrderCloud.ProductFacet
• 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
• OrderCloud.VariantInventory

Documentation for Authorization

oauth2

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