Shift Node API

Getting Started

To install shift-node-api

npm i @shiftcommerce/shift-api or yarn add @shiftcommerce/shift-api

Defining a Config

To be able to use the api calls from shift-node-api you need to use the config and pass variables that are needed to make the call.

The three variables needed are:

• apiHost - url to the host
• apiTenant - name of your tenant
• apiAccessToken - token generated by the api

for example

import { shiftApiConfig } from @shiftcommerce/shift-node-api

shiftApiConfig.set({
  apiHost: https://urlToApiHost.com,
  apiTenant: tenantName,
  apiAccessToken: $2y$12$UtYj8DA7YG3w26IB/votEeI7wto5U890qI6cDQ7dowllIgx.53bKO,
})

Once the config has been defined you should be able to use SHIFTClient

SHIFTClient

createAssetsFilesV1(assets)

createProductAssetFilesV1(mappings)

getMenusV1(query)

getCartV1(cartId, query)

addLineItemToCartV1(req, res, cartId)

createNewCartWithLineItemV1(req, res)

assignCartToCustomerV1(cartId, customerId)

deleteLineItemV1(lineItemId, cartId)

updateLineItemV1(newQuantity, cartId, lineItemId)

addCartCouponV1(couponCode, cartId)

setCartShippingMethodV1(cartId, shippingMethodId)

getShippingMethodsV1()

createCustomerAddressV1(req)

setCartBillingAddressV1(addressId, cartId)

setCartShippingAddressV1(addressId, cartId)

getResourceBySlugV1(queryObject)

getProductV1(id, query)

getStaticPageV1(id, query)

getCategoryV1(id, query)

getAccountV1(queryObject, customerId)

createCustomerAccountV1(account)

loginCustomerAccountV1(account)

getCustomerOrdersV1(query)

getAddressBookV1(customerAccountId, query)

createAddressBookEntryV1(body, customerAccountId)

deleteAddressV1(addressId, customerAccountId)

createOrderV1(orderPayload)

getCustomerAccountByEmailV1(email)

createPasswordRecoveryV1(accountId, data)

getCustomerAccountByTokenV1(token)

updateCustomerAccountPasswordV1(accountId, body)