This Ordercloud API Exercise is aimed to help you get familiar with and utilizing all of the different endpoints offered in the API. For the length of the exercise, we will work with one Company and one Product Catalog. The organization and product catalog structures are outlined for you - allowing you to focus on the core concepts. This exercise is to be completed in the program Postman. We will be using environment variables to help streamline the workflow, you can read about those here. There is a template here with all of the different keys you will be using throughout these exercises, you can import them into your postman environment and fill in the values as you go.
\nNorthern Lights Coffee is a Coffee Supply Company that sells products to two different coffee shops: Metro Coffee and Cloud Coffee. NLC is in need of a B2B Custom solution that will allow them to create and manage catalogs with products and have those products visible to their different coffee shops (Buyers) for them to purchase to be sold/used in their coffee shops. The organization structure is as follows (you will want to refer back to this diagram for insight into different organizational considerations while going through the exercises).
\nThis exercise will be facilitated by an application called Postman. If you don't yet have it installed, visit this Link to install.
\nWhat is Postman? For a nice article that can explain it better than I - click here.
\nThe first thing you will want to do before you begin the exercises is visit the OrderCloud Portal and register for an account. This grants you access to create OrderCloud organizations and manipulate them through the API Console, which you will use frequently when developing Ordercloud Applications. If you already created an account, go ahead and sign in using your credentials.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13422742","collectionId":"20682f6e-346b-4a69-b498-3690f69f35e3","publishedId":"TVt19jd1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-12-30T22:51:19.000Z"},"item":[{"name":"1. Getting Started","item":[],"id":"40740849-92e2-4693-9a67-d589d0ee2369","description":"Now that you're logged into the OrderCloud Portal, you should be able to view your dashboard. If this is your first time logging in it may seem a little empty right now. The first thing you'll do at the beginning of any OrderCloud project is create a new Seller Organization. You can do this by clicking on the NEW ORGANIZATION button in the upper right corner of the Seller Organizations widget. This opens up a dialog where you can enter in the necessary details for a new Seller Organization. You can choose the name of the seller organization. For the purposes of these exercises let's use the example \"Northern Lights Coffee\" for the Organization name.
\nWhen ready, click the CREATE ORGANIZATION button at the bottom.
\nOnce your organization has been created you will be directed to it's settings page. Here you can access the ID of your Seller Organization - copy it and add it to your Postman environment variables (CTRL + ALT + E) under org_id. Make sure you add the values to both the ‘Initial Value’ and ‘Current Value’ fields (this has something to do with Postman not storing values in a database, as some of this data can be sensitive).
\n\nIf you haven't used the Portal's API Console before, read this article.
\n
Next, you need to create an API client for both your buyer and seller application. API Clients define various access points to your organizations data. These access points have properties that control what parties can use it, how they can gain access and for how long that access remains valid. We need an API client before we can get a valid OrderCloud token.
\nNavigate to the OrderCloud API CONSOLE and click API CLIENTS. Select CREATE NEW API CLIENT to create buyer and seller clients with the options shown.
\nFirst, go ahead and create the seller client. Only seller users can authenticate via this seller client.
\nThen go ahead and create the buyer client. Only buyer users can authenticate via this buyer client.
\nUpdate your environmental variables with values for clientID_seller and clientID_buyer.
Now we need to create an admin user and an initial buyer. Click ADMIN USERS and create an admin user with username nlcadmin. Make sure to check the ACTIVE box.
Update your environmental variables with values for admin_username (nlcadmin), admin_password and admin_user_id.
Select BUYERS to create your initial buyer. Use metro_coffee for the id and check the ACTIVE box.
Update your environmental variables with values for buyer_username (metrocoffeebuyer) and buyerID (metro_coffee).
To complete the initial setup, you need to create security profiles and assign \"Full Access\" to your admin user. From the OrderCloud API Console, navigate to SECURITY PROFILES and click CREATE NEW SECURITY PROFILE. Create one with Name and ID FullAccess.
Next, create another Security Profile for buyer access with Name and ID buyerProfile1.
Finally, assign your admin user to the FullAccess profile. Click the lightning bolt icon to reveal a dropdown containing relevant HTTP requests and select POST CREATE OR UPDATE A SECURITY PROFILE ASSIGNMENT. Input Security Profile ID: FullAccess and use the generated ID you stored as adminUserID for User ID.
\n\n","event":[{"listen":"prerequest","script":{"id":"595e045e-0049-4763-b8e4-77575133da9e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4738e379-4c54-4ce3-a27f-6314e013b064","type":"text/javascript","exec":[""]}}],"_postman_id":"40740849-92e2-4693-9a67-d589d0ee2369"},{"name":"2. Authentication","item":[{"name":"Get Admin User Token (nlcadmin)","id":"a09c85d5-fa55-4600-87a8-1d7a2740353c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"53181F89-0251-4483-90A8-178379A11FBD","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"steinmetzadmin","type":"text"},{"key":"password","value":"fails345","type":"text"},{"key":"scope","value":"BuyerUserAdmin Shopper UserGroupAdmin AddressAdmin SpendingAccountAdmin BuyerAdmin ProductReader ProductAdmin CatalogReader CatalogAdmin CategoryReader CategoryAdmin PriceScheduleReader PriceScheduleAdmin SecurityProfileAdmin SetSecurityProfile OrderAdmin UnsubmittedOrderReader ShipmentAdmin PromotionAdmin ProductFacetAdmin ApprovalRuleAdmin BuyerImpersonation AdminUserReader AdminUserAdmin ApiClientReader ApiClientAdmin XpIndexAdmin","type":"text"}]},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a09c85d5-fa55-4600-87a8-1d7a2740353c"},{"name":"Get Buyer (Metro Coffee) User Token (bill - Northeast)","id":"913264e5-60b5-4b8a-8e49-058c182724b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{clientID_buyer}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"bill","type":"text"},{"key":"password","value":"test1234","type":"text"},{"key":"scope","value":"scope=Shopper MeAdmin PromotionReader MeCreditCardAdmin BuyerImpersonation","type":"text"}]},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"913264e5-60b5-4b8a-8e49-058c182724b7"},{"name":"Get Buyer (Metro Coffee) User Token (jill - Uptown)","id":"83006057-50a4-454e-8597-be2aba6ab229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{clientID_buyer}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"jill","type":"text"},{"key":"password","value":"test1234","type":"text"},{"key":"scope","value":"Shopper MeAdmin PromotionReader MeCreditCardAdmin BuyerImpersonation","type":"text"}]},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"83006057-50a4-454e-8597-be2aba6ab229"},{"name":"Get Buyer (Cloud Coffee) User Token (grace - Los Angeles)","id":"9523fd5b-9111-4177-8580-7816175685c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{clientID_buyer}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"grace","type":"text"},{"key":"password","value":"test1234","type":"text"},{"key":"scope","value":"Shopper MeAdmin PromotionReader MeCreditCardAdmin BuyerImpersonation","type":"text"}]},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9523fd5b-9111-4177-8580-7816175685c2"}],"id":"1421c37a-e4e4-476b-9ec7-031bcd6efa0d","description":"For more information on how Organization Hierarchy works see this article.
\n
Each of the requests in this folder is for retrieving an OrderCloud access_token for a specific user in your organization. We've already stored the necessary information for making these requests in the previous exercises Environment Variables section. You will be using these commands to get (and refresh) user tokens each day you work on these exercises as each token will expire ~8.5 hours after they're generated.
Run the Get Admin User Token (nlcadmin) request now and observe the data you get back. There's an access_token as well as bearer_type and an expires_in integer. Bearer tokens are going to be used on every single request that we make to the OrderCloud API. The type of tokens we use are structured JWT tokens (you can read about Bearer tokens here).
For the purposes of these exercises we will be asking you to store the access_tokens you get back from these requests in Postman environment variables. For example, take the Admin User access_token you just got back and save it under the admin_token environment variable. Now, whenever an operation needs to be executed on behalf of an Admin (Seller) user Postman will automatically add the correct token to your Authorization details. Each \"Get Buyer Token\" request has it's own corresponding buyer_token environment variable with the user's Name appended to it.
The next step is to create more buyer users for the initial buyer we created, Metro Coffee. In a traditional business case, the administrator would create new buyer users, so we will be using the admin token for authentication. We will create three more buyer users. Go ahead and inspect, then run the requests in 3A.
\n","event":[{"listen":"prerequest","script":{"id":"546512c1-2e65-4a5c-931e-318c74f07b92","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8387f341-753c-4922-b525-62662b4e193c","type":"text/javascript","exec":[""]}}],"_postman_id":"624ea8a3-af52-46d4-b7f8-06920cbe5963"},{"name":"B. Create Buyer User Groups","item":[{"name":"Create Buyer User Group (Uptown)","id":"4407420a-21bd-49ae-b802-9fc9fdb19b2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"uptown\",\r\n \"Name\": \"Uptown\",\r\n \"Description\": \"Metro Coffee - Uptown\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4407420a-21bd-49ae-b802-9fc9fdb19b2f"},{"name":"Create Buyer User Group (Northeast)","id":"4e271137-c641-46c7-b130-8af6a61a0593","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"northeast\",\r\n \"Name\": \"Northeast\",\r\n \"Description\": \"Metro Coffee - Northeast\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e271137-c641-46c7-b130-8af6a61a0593"}],"id":"a0e993b4-9c05-41b4-8273-c75e32faadc8","description":"Now that we have our buyer users, we want to organize them into buyer user groups, which in our business case represent different locations of the Metro Coffee franchise. We have Metro Coffee - Northeast, and Metro Coffee - Uptown. Before we can organize our users into these groups, we have to create them! Go ahead and run the requests.
\n","event":[{"listen":"prerequest","script":{"id":"f5f5852f-c92a-41ab-abe3-e0de06a912df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"edbc6905-4a55-4948-9edb-9697cfe1eb55","type":"text/javascript","exec":[""]}}],"_postman_id":"a0e993b4-9c05-41b4-8273-c75e32faadc8"},{"name":"C. Assign Buyer Users to Buyer User Groups","item":[{"name":"Assign Buyer User (Jill Test) to Buyer User Group (Uptown)","id":"ea732c53-705e-43b7-b583-dbbfd7fe6479","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"uptown\",\r\n \"UserID\": \"jill\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea732c53-705e-43b7-b583-dbbfd7fe6479"},{"name":"Assign Buyer User (Bill Test) to Buyer User Group (Northeast)","id":"393bc1a4-e23e-445a-a7ea-88d753e9b673","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"northeast\",\r\n \"UserID\": \"bill\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"393bc1a4-e23e-445a-a7ea-88d753e9b673"},{"name":"Assign Buyer User (Jon Test) to Buyer User Group (Northeast)","id":"0449b4b2-d51e-4ad4-8416-12711f0d164e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"northeast\",\r\n \"UserID\": \"jon\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0449b4b2-d51e-4ad4-8416-12711f0d164e"},{"name":"List Buyer User Group Assignments","id":"af6243f2-1420-4f79-b2f5-d8c60c793fb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af6243f2-1420-4f79-b2f5-d8c60c793fb6"}],"id":"960c2ff2-2968-46e9-b543-4fdbac120162","description":"Now that we have our users and user groups created, we need to assign users to the different user groups. We will do this through Buyer/UserGroup assignments. Go ahead and run the requests. These requests don’t have anything in the response body, so to confirm the assignments were made, at the end we will List Buyer User Group Assignments.
\n","event":[{"listen":"prerequest","script":{"id":"48d1d0d4-bb51-42cf-af30-13a121983700","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a21bc9e1-a243-46d3-885f-aed7ddd8a8b6","type":"text/javascript","exec":[""]}}],"_postman_id":"960c2ff2-2968-46e9-b543-4fdbac120162"},{"name":"D. Create Buyer Addresses","item":[{"name":"Create Buyer Address (Uptown)","id":"7fec0f10-df49-4f56-82f9-bc0cae70e55f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"uptown\",\r\n \"CompanyName\": \"Metro Coffee - Uptown\",\r\n \"FirstName\": \"Jill\",\r\n \"LastName\": \"Test\",\r\n \"Street1\": \"2504 Rocket Drive\",\r\n \"Street2\": \"\",\r\n \"City\": \"Minneapolis\",\r\n \"State\": \"MN\",\r\n \"Zip\": \"55409\",\r\n \"Country\": \"US\",\r\n \"Phone\": \"6128244475\",\r\n \"AddressName\": \"Uptown Shipping\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fec0f10-df49-4f56-82f9-bc0cae70e55f"},{"name":"Create Buyer Address (Northeast)","id":"62879918-7b89-4aa5-bd7d-6a4c92e6c7b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"northeast\",\r\n \"CompanyName\": \"Metro Coffee - Northeast\",\r\n \"FirstName\": \"Bill\",\r\n \"LastName\": \"Test\",\r\n \"Street1\": \"591 Willson St NE\",\r\n \"Street2\": \"\",\r\n \"City\": \"Minneapolis\",\r\n \"State\": \"MN\",\r\n \"Zip\": \"55401\",\r\n \"Country\": \"US\",\r\n \"Phone\": \"6128059997\",\r\n \"AddressName\": \"Northeast Shipping\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62879918-7b89-4aa5-bd7d-6a4c92e6c7b0"},{"name":"List Buyer Addresses","id":"19b3e912-703b-48b5-b1da-9768e96e915f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"19b3e912-703b-48b5-b1da-9768e96e915f"}],"id":"116f7f7a-ae12-4870-91d3-19adb9d21fd9","description":"Next, we’ll create Addresses for each of our franchise locations (User Groups). These addresses represent the addresses for which can be used for ‘Billing’, ‘Shipping’ or both. We will define those parameters when we assign these addresses to the User Groups in the next step. Go ahead and run the requests.
\n","event":[{"listen":"prerequest","script":{"id":"007d6ef8-7b62-4153-8892-644e5ef0806c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7409a2d8-c07d-4196-a62c-f6ffe9fd0c81","type":"text/javascript","exec":[""]}}],"_postman_id":"116f7f7a-ae12-4870-91d3-19adb9d21fd9"},{"name":"E. Assign Buyer Addresses to Buyer User Groups","item":[{"name":"Assign Buyer Address (Uptown) to Buyer User Group (Uptown)","id":"b2649a4f-249a-4a41-8378-20092dd962b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"AddressID\": \"uptown\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"uptown\",\r\n \"IsShipping\": true,\r\n \"IsBilling\": true\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2649a4f-249a-4a41-8378-20092dd962b6"},{"name":"Assign Buyer Address (Northeast) to Buyer User Group (Northeast)","id":"a9b94984-9563-42e3-ba67-34f5700e1ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"AddressID\": \"northeast\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"northeast\",\r\n \"IsShipping\": true,\r\n \"IsBilling\": true\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9b94984-9563-42e3-ba67-34f5700e1ef0"},{"name":"List Buyer Address Assignments","id":"94ba3500-0544-44fc-82a9-da67234c2484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"94ba3500-0544-44fc-82a9-da67234c2484"}],"id":"3b33a1ea-19f2-4c15-b610-8210b6d6f59d","description":"Now that we have the addresses created, we will assign them to their respective User Groups. Notice that in the request body, we are defining whether or not the address is to be used for Billing, Shipping, or both. Go ahead and run the requests. These requests yield no response body, so to confirm our assignments were made, we will make a request to List Buyer Address Assignments.
\n","event":[{"listen":"prerequest","script":{"id":"0b1f118c-76ad-428b-8f9d-e4e2622688cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e75ce83-7d4d-4c49-ae41-b44be0f29345","type":"text/javascript","exec":[""]}}],"_postman_id":"3b33a1ea-19f2-4c15-b610-8210b6d6f59d"},{"name":"F. Create Buyer Spending Accounts","item":[{"name":"Create Buyer Spending Account (Uptown)","id":"ba1ef3da-a848-4700-98ab-36e996064530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"uptown_spending_account\",\r\n \"Name\": \"Uptown Store Budget\",\r\n \"Balance\": 25000,\r\n \"AllowAsPaymentMethod\": true,\r\n \"RedemptionCode\": \"\",\r\n \"StartDate\": \"\",\r\n \"EndDate\": \"\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba1ef3da-a848-4700-98ab-36e996064530"},{"name":"Create Buyer Spending Account (Northeast)","id":"f6d4b58e-b026-411c-8915-375ee7c032b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"northeast_spending_account\",\r\n \"Name\": \"Northeast Store Budget\",\r\n \"Balance\": 50000,\r\n \"AllowAsPaymentMethod\": true,\r\n \"RedemptionCode\": \"\",\r\n \"StartDate\": \"\",\r\n \"EndDate\": \"\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6d4b58e-b026-411c-8915-375ee7c032b5"},{"name":"List Buyer Spending Accounts","id":"e4dd1085-9475-43be-8514-cbf3cb237649","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4dd1085-9475-43be-8514-cbf3cb237649"}],"id":"b82c03b7-6c7c-4dc6-b699-bb6603a535d7","description":"Next we’ll create Spending Accounts. Go ahead and run the requests.
\n","event":[{"listen":"prerequest","script":{"id":"e7c23ef3-2dab-414b-b9c4-3a584819db1f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"737271bd-b0b3-457d-93b4-6e3a57bd96ff","type":"text/javascript","exec":[""]}}],"_postman_id":"b82c03b7-6c7c-4dc6-b699-bb6603a535d7"},{"name":"G. Assign Buyer Spending Accounts to Buyer User Groups","item":[{"name":"Assign Buyer Spending Account (Uptown) to Buyer User Group (Uptown)","id":"65f40db6-bed6-4db1-8389-8e08a73caf34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SpendingAccountID\": \"uptown_spending_account\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"uptown\",\r\n \"AllowExceed\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65f40db6-bed6-4db1-8389-8e08a73caf34"},{"name":"Assign Buyer Spending Account (Northeast) to Buyer User Group (Northeast)","id":"a4637040-7e29-4adb-a14b-c7c6881415bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"SpendingAccountID\": \"northeast_spending_account\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"northeast\",\r\n \"AllowExceed\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4637040-7e29-4adb-a14b-c7c6881415bf"},{"name":"List Buyer Spending Accounts Assignments","id":"813eb09f-87b3-42a5-933d-1e618d4e63bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"813eb09f-87b3-42a5-933d-1e618d4e63bc"}],"id":"6e39b4a8-096e-4885-b2a1-25c8da932cbc","description":"Now we’ll assign those newly created spending accounts to their respective User Groups! Go ahead and run those requests, then run the request to List Buyer Spending Account Assignments.
\n","event":[{"listen":"prerequest","script":{"id":"e41ea405-3b4f-4c30-8dce-685e1722ce79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"321ca5d1-82b1-4c81-bacb-2d8759338be2","type":"text/javascript","exec":[""]}}],"_postman_id":"6e39b4a8-096e-4885-b2a1-25c8da932cbc"}],"id":"71f725d1-a32e-4501-8ef5-0abc2c2c28f9","description":"Let's expand on our intial Buyer we created when we created our organization!
\n","event":[{"listen":"prerequest","script":{"id":"47ac092e-650c-4ff2-9a9d-2e8be65d6f99","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"57c7a58d-1ceb-43dc-9457-4b9a56fe42f7","type":"text/javascript","exec":[""]}}],"_postman_id":"71f725d1-a32e-4501-8ef5-0abc2c2c28f9"},{"name":"4. Creating and Expanding Second Buyer (Cloud Coffee)","item":[{"name":"A. Create Second Buyer (Cloud Coffee)","item":[{"name":"Create Buyer (Cloud Coffee)","id":"5a1f7040-f8fe-46e0-8842-1d34c4d2716b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"cloud_coffee\",\r\n \"Name\": \"Cloud Coffee\",\r\n \"DefaultCatalogID\": \"\",\r\n \"Active\": true,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers","urlObject":{"path":["v1","buyers"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a1f7040-f8fe-46e0-8842-1d34c4d2716b"}],"id":"a20ea639-4365-46f4-861e-bd360ebec290","description":"First, we'll create the Buyer. To do this, we will still be authenticating as the admin user, using the admin_token.
The next few steps are going to be pretty similar to what we did for the first buyer - but this time we will be following the steps for the second buyer we just created: cloud_coffee. You will need to make sure that you change the environment variable buyerID to cloud_coffee in your env vars.
Now that we've created our three buyer users, lets assign them to our two different User Groups that represent the franchise locations: Los Angeles and Burbank. First, we need to create these Buyer User Groups.
\n","event":[{"listen":"prerequest","script":{"id":"6285e4b8-2d22-44df-80ec-af945fb316e1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"52191be5-8663-443e-a99a-269471fde4e2","type":"text/javascript","exec":[""]}}],"_postman_id":"6255f653-0c27-41e9-aa8e-0543643fb434"},{"name":"D. Assign Buyer Users to Buyer User Groups","item":[{"name":"Assign Buyer User (Grace Test) to Buyer User Group (Los Angeles)","id":"b5e40f85-b0b4-44aa-b3c6-3e3c31a74b7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"la\",\r\n \"UserID\": \"grace\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5e40f85-b0b4-44aa-b3c6-3e3c31a74b7c"},{"name":"Assign Buyer User (Todd Test) to Buyer User Group (Burbank)","id":"75e2e51d-c731-4601-87e3-786814f73904","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"burbank\",\r\n \"UserID\": \"todd\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"75e2e51d-c731-4601-87e3-786814f73904"},{"name":"Assign Buyer User (June Test) to Buyer User Group (Burbank)","id":"61501c32-d77e-4319-923c-9f831d31c9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserGroupID\": \"burbank\",\r\n \"UserID\": \"june\"\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61501c32-d77e-4319-923c-9f831d31c9b7"},{"name":"List Buyer User Group Assignments","id":"ce4288f8-c710-40a8-bb00-08a2e2d4fa6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/usergroups/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","usergroups","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce4288f8-c710-40a8-bb00-08a2e2d4fa6d"}],"id":"f8893ed4-71e5-4d41-a39e-af7cf2d21b8c","description":"Now that we have our Buyer User Groups created, lets assign our different users to their respecitve User Groups.
\n","event":[{"listen":"prerequest","script":{"id":"53446163-f0fe-4683-ab61-22764da416ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"87010b39-8f61-48de-82bb-3d690510e5da","type":"text/javascript","exec":[""]}}],"_postman_id":"f8893ed4-71e5-4d41-a39e-af7cf2d21b8c"},{"name":"E. Create Buyer Addresses","item":[{"name":"Create Buyer Address (Los Angeles)","id":"9b813084-25b5-46be-9b8f-fa1d24ac3f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"la_shipping\",\r\n \"CompanyName\": \"Cloud Coffee - Los Angeles\",\r\n \"FirstName\": \"Grace\",\r\n \"LastName\": \"Test\",\r\n \"Street1\": \"804 Thompson Street\",\r\n \"Street2\": \"\",\r\n \"City\": \"Los Angeles\",\r\n \"State\": \"CA\",\r\n \"Zip\": \"90017\",\r\n \"Country\": \"US\",\r\n \"Phone\": \"3102103355\",\r\n \"AddressName\": \"Los Angeles Shipping\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b813084-25b5-46be-9b8f-fa1d24ac3f39"},{"name":"Create Buyer Address (Burbank)","id":"f8e57ae6-d481-4da5-841d-eb7bdecc4b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"burbank_shipping\",\r\n \"CompanyName\": \"Cloud Coffee - Burbank\",\r\n \"FirstName\": \"Todd\",\r\n \"LastName\": \"Test\",\r\n \"Street1\": \"3055 Joy Lane\",\r\n \"Street2\": \"\",\r\n \"City\": \"Burbank\",\r\n \"State\": \"CA\",\r\n \"Zip\": \"91502\",\r\n \"Country\": \"US\",\r\n \"Phone\": \"2139260601\",\r\n \"AddressName\": \"Burbank Shipping\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8e57ae6-d481-4da5-841d-eb7bdecc4b4a"},{"name":"List Buyer Addresses","id":"c6610e5c-8fc0-45f7-b606-ea411eb444ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6610e5c-8fc0-45f7-b606-ea411eb444ce"}],"id":"54441db5-4809-4cbc-9548-79a23e7ef40d","description":"Next, let's create Buyer Addresses that we can associate each of these franchise locations (Buyer User Groups) to.
\n","event":[{"listen":"prerequest","script":{"id":"d971c5e7-6390-4d6e-bcc4-f06141c2dc45","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a91f5a27-1f9f-4b4a-af8f-4e8d48c42a86","type":"text/javascript","exec":[""]}}],"_postman_id":"54441db5-4809-4cbc-9548-79a23e7ef40d"},{"name":"F. Assign Buyer Addresses to Buyer User Groups","item":[{"name":"Assign Buyer Address (LA Shipping) to Buyer User Group (Los Angeles)","id":"341b67f8-30a3-45a2-a82d-d283e549a138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"AddressID\": \"la_shipping\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"la\",\r\n \"IsShipping\": true,\r\n \"IsBilling\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"341b67f8-30a3-45a2-a82d-d283e549a138"},{"name":"Assign Buyer Address (Burbank Shipping) to Buyer User Group (Burbank)","id":"229c5021-bc04-43e4-bc0c-b560f066193b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"AddressID\": \"burbank_shipping\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"burbank\",\r\n \"IsShipping\": true,\r\n \"IsBilling\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"229c5021-bc04-43e4-bc0c-b560f066193b"},{"name":"List Buyer Address Assignments","id":"76d92607-2c27-4874-bf30-e771ff4676af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/addresses/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","addresses","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76d92607-2c27-4874-bf30-e771ff4676af"}],"id":"72098b2f-131f-4182-8f43-e410e153abe5","description":"Now that both our Cloud Coffee Users and Addresses are created, let's make the assignments.
\n","event":[{"listen":"prerequest","script":{"id":"f2c0d1df-dff0-4b6e-997c-b264d91e9d83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"11408c84-edad-4484-bdcc-d8139d2c9da9","type":"text/javascript","exec":[""]}}],"_postman_id":"72098b2f-131f-4182-8f43-e410e153abe5"},{"name":"G. Create Buyer Spending Accounts","item":[{"name":"Create Buyer Spending Account (Los Angeles)","id":"aa924c15-dfdf-4eac-b435-9b67e0918c31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"la_spending_account\",\r\n \"Name\": \"Los Angeles Store Budget\",\r\n \"Balance\": 25000,\r\n \"AllowAsPaymentMethod\": true,\r\n \"RedemptionCode\": \"\",\r\n \"StartDate\": \"\",\r\n \"EndDate\": \"\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa924c15-dfdf-4eac-b435-9b67e0918c31"},{"name":"Create Buyer Spending Account (Burbank)","id":"6a1f7560-8938-491f-ac8e-c9aac8e22a47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"burbank_spending_account\",\r\n \"Name\": \"Burbank Store Budget\",\r\n \"Balance\": 50000,\r\n \"AllowAsPaymentMethod\": true,\r\n \"RedemptionCode\": \"\",\r\n \"StartDate\": \"\",\r\n \"EndDate\": \"\",\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a1f7560-8938-491f-ac8e-c9aac8e22a47"},{"name":"List Buyer Spending Accounts","id":"a67ac7f1-ee78-45a9-a6af-9a7eacb21923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a67ac7f1-ee78-45a9-a6af-9a7eacb21923"}],"id":"69a0eb33-dcaa-484a-b964-245470fa37a6","description":"Now, we will create Spending Accounts to associate with each of our locations (Buyer User Groups).
\n","event":[{"listen":"prerequest","script":{"id":"3e9cd196-b856-4f6f-a422-0e2c652194a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8ff407e8-c2bf-4957-b044-efb6b6cb37a6","type":"text/javascript","exec":[""]}}],"_postman_id":"69a0eb33-dcaa-484a-b964-245470fa37a6"},{"name":"H. Assign Buyer Spending Accounts to Buyer User Groups","item":[{"name":"Assign Buyer Spending Account (Los Angeles) to Buyer User Group (Los Angeles)","id":"0b56eab0-7afe-4791-a922-670306413bd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SpendingAccountID\": \"la_spending_account\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"la\",\r\n \"AllowExceed\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b56eab0-7afe-4791-a922-670306413bd3"},{"name":"Assign Buyer Spending Account (Burbank) to Buyer User Group (Burbank)","id":"5d743756-6db1-4996-b337-7786fef5176f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"SpendingAccountID\": \"burbank_spending_account\",\r\n \"UserID\": \"\",\r\n \"UserGroupID\": \"burbank\",\r\n \"AllowExceed\": false\r\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d743756-6db1-4996-b337-7786fef5176f"},{"name":"List Buyer Spending Accounts Assignments","id":"447c5ec3-3733-401f-bf74-809d4d1e1c01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/spendingaccounts/assignments","urlObject":{"path":["v1","buyers","{{buyerID}}","spendingaccounts","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"447c5ec3-3733-401f-bf74-809d4d1e1c01"}],"id":"7b50eb5d-99f0-4cb0-90a2-b577895769bf","description":"Now let's assign these Spending Accounts to their respective locations.
\n","event":[{"listen":"prerequest","script":{"id":"dba8df3f-d9bb-49fc-81f2-e9bd48ea8b60","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f465022-23ad-4639-a541-1b20dc8bff50","type":"text/javascript","exec":[""]}}],"_postman_id":"7b50eb5d-99f0-4cb0-90a2-b577895769bf"}],"id":"50aa9c64-7305-430a-9fb1-11f83c76c370","description":"Now that we have our first Buyer created and fleshed out, lets create a second Buyer to represent a second Coffee Shop that will be ordering product from Northern Lights Coffee as well. This Coffee Shop will also have two franchise locations: Los Angeles and Burbank.
\n","event":[{"listen":"prerequest","script":{"id":"585aeadd-fc96-4b4f-8f76-f372dcd6e543","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bf6340b-7c6c-4fa2-b5c4-3c831907fbe4","type":"text/javascript","exec":[""]}}],"_postman_id":"50aa9c64-7305-430a-9fb1-11f83c76c370"},{"name":"5. Assign Security Profiles to Buyers","item":[{"name":"Assign Security Profile (buyerProfile1) to Buyer (Metro Coffee)","id":"0cec7def-d392-4f75-b685-86721f8c1076","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"SecurityProfileID\": \"buyerProfile1\",\r\n \"BuyerID\": \"metro_coffee\"\r\n}"},"url":"{{baseApiUrl}}/v1/securityprofiles/assignments","urlObject":{"path":["v1","securityprofiles","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cec7def-d392-4f75-b685-86721f8c1076"},{"name":"Assign Security Profile (buyerProfile1) to Buyer (Cloud Coffee)","id":"24063f65-e0f6-45bf-9919-0fe8230463b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"SecurityProfileID\": \"buyerProfile1\",\r\n \"BuyerID\": \"cloud_coffee\"\r\n}"},"url":"{{baseApiUrl}}/v1/securityprofiles/assignments","urlObject":{"path":["v1","securityprofiles","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24063f65-e0f6-45bf-9919-0fe8230463b6"},{"name":"Patch buyerProfile1 to include BuyerImpersonation Role","id":"b9e582ee-ccf8-4cca-ae66-829cbc6dd51a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"Roles\": [\n\t \"MeAddressAdmin\",\n\t \"MeAdmin\",\n\t \"MeCreditCardAdmin\",\n\t \"MeXpAdmin\",\n\t \"Shopper\",\n\t \"BuyerImpersonation\"\n\t],\n}"},"url":"{{baseApiUrl}}/v1/securityprofiles/buyerProfile1","description":"Later in the exercise, we will be working with some Buyer Impersonation - so let's PATCH buyerProfile1 to include BuyerImpersonation as a role. Since this profile already exists, PATCH will overwrite the whole object, so we need to include all the roles this profile held previously along with the new role we are including.
We've successfully created and expanded on two Buyers within our Admin Organization! Pat yourself on the back. Now that we have our organization structure built out a little bit, we'll move on to working with the Buyers a little bit more.
\nThe first thing we'll need to do before working with our buyer users is assign them security profiles. Security Profiles are basically sets of Roles that you give a user, granting them access to certain endpoints within their token. When we created our org, a security profile was created for us (buyerProfile1) and it contains all the roles that we will need in order to complete our requests as buyer users. Lets assign this profile to each of our Buyers.
To start off, let's create several products. These products are created in isolation, and then made visible to the end buyer user through various assignments. These relationships are collectively referred to as Product Visibility. Creating products is another administrative task, so we will be authenticating as the admin user, using the admin_token.
Run the requests to create 9 products, and then List all the products to see them return.
\n","event":[{"listen":"prerequest","script":{"id":"0d652787-768a-40fe-b6d0-5c7e9d085404","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7b016dcf-537b-47f7-a93e-bfc6bce2abf8","type":"text/javascript","exec":[""]}}],"_postman_id":"7e7d0c2e-0eb0-4c4e-9799-71a0949cd616"},{"name":"B. Creating a Catalog","item":[{"name":"Create Catalog","id":"d37f8a04-4911-4b18-a465-4e6cd0ebc0b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"nlc_catalog\",\r\n \"Name\": \"Northern Lights Coffee Product Catalog\",\r\n \"Description\": \"Products all supplied by Northern Lights Coffee Roastery\",\r\n \"Active\": true,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs","urlObject":{"path":["v1","catalogs"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d37f8a04-4911-4b18-a465-4e6cd0ebc0b7"},{"name":"List Catalogs","id":"7a5cae65-0d0f-4735-ae7e-1489e37eb538","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/catalogs","urlObject":{"path":["v1","catalogs"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a5cae65-0d0f-4735-ae7e-1489e37eb538"}],"id":"951704f9-7625-41a6-9bdc-0defb9372cc7","description":"Now that we have our 9 products, we need to associate them with a catalog that the Seller Org can offer to it's buyers (at varying levels of visibility) in order for the buyers to order products.
\nLet's create the catalog.
\n","event":[{"listen":"prerequest","script":{"id":"f82eda8e-7ec1-4072-a3d7-df61e5ec2a36","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1963bbf-5698-4a59-b238-4b39f4953710","type":"text/javascript","exec":[""]}}],"_postman_id":"951704f9-7625-41a6-9bdc-0defb9372cc7"},{"name":"C. Assign Catalog to Buyers","item":[{"name":"Assign Catalog to Buyer (Metro Coffee)","id":"fda8d607-20f7-4f82-8628-6c07a7a569cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CatalogID\": \"nlc_catalog\",\r\n \"BuyerID\": \"metro_coffee\",\r\n \"ViewAllCategories\": true,\r\n \"ViewAllProducts\": true\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/assignments","urlObject":{"path":["v1","catalogs","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fda8d607-20f7-4f82-8628-6c07a7a569cf"},{"name":"Assign Catalog to Buyer (Cloud Coffee)","id":"76ed8091-5625-431f-b6fe-f15d2d6a118a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CatalogID\": \"nlc_catalog\",\r\n \"BuyerID\": \"cloud_coffee\",\r\n \"ViewAllCategories\": true,\r\n \"ViewAllProducts\": true\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/assignments","urlObject":{"path":["v1","catalogs","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"76ed8091-5625-431f-b6fe-f15d2d6a118a"},{"name":"List Catalog Assignments","id":"1020a40d-1f1a-4d8a-a8d1-791ec72cd34c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/catalogs/assignments","urlObject":{"path":["v1","catalogs","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1020a40d-1f1a-4d8a-a8d1-791ec72cd34c"}],"id":"ec619302-8f1c-45d0-9657-8ee0bbf21046","description":"Our catalog is created, now let's assign the catalog (nlc_catalog) to both of our Buyers, so that they both have access to it. To start off with, we will have ViewAllCategories and ViewAllProducts set to true, so that the Buyers call view all the Products in this catalog. We will refine visibility later. You can read about product visibility here.
Now that we have the catalog created and assigned to both buyers, lets refine the catalog by adding Categories. The following requests require that we have a defined catalog_id to associate these categories to - let's add our catalog ID (nlc_catalog) to our envirnoment variables.
Run the requests to create 3 different categories: Coffee Supplies, Coffehouse Essentials and Coffeehouse Snacks.
\n","event":[{"listen":"prerequest","script":{"id":"acce8c4f-23c7-45c6-acc4-c9e09e92899b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb3f6b98-ec99-4d5d-9e83-c3053793ba19","type":"text/javascript","exec":[""]}}],"_postman_id":"97135df2-3a43-41c4-9517-3e4273ac5caf"},{"name":"E. Assign Products to Categories","item":[{"name":"Assign Product (Coffee Cups) to Category (Coffeehouse Essentials)","id":"6c0c1622-a22f-471d-a0d3-c46819856c72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffeehouse_essentials\",\r\n \"ProductID\": \"coffee_cups\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c0c1622-a22f-471d-a0d3-c46819856c72"},{"name":"Assign Product (Espresso Tamp) to Category (Coffeehouse Essentials)","id":"8db9d961-210f-476d-91b5-148c846e581f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffeehouse_essentials\",\r\n \"ProductID\": \"espresso_tamper\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8db9d961-210f-476d-91b5-148c846e581f"},{"name":"Assign Product (Barista Apron) to Category (Coffeehouse Essentials)","id":"bb45abf1-27d2-41da-b5ff-0f03cc9cd135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffeehouse_essentials\",\r\n \"ProductID\": \"barista_apron\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb45abf1-27d2-41da-b5ff-0f03cc9cd135"},{"name":"Assign Product (Bar Towels) to Category (Coffeehouse Essentials)","id":"2c626cbe-db33-4019-9ab8-c43040061731","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffeehouse_essentials\",\r\n \"ProductID\": \"bar_towels\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c626cbe-db33-4019-9ab8-c43040061731"},{"name":"Assign Product (Coffee Beans - Ground) to Category (Coffee Supplies)","id":"aa841dd4-a15a-487a-9adf-e5db321164b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffee_supplies\",\r\n \"ProductID\": \"ground_coffee_beans\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa841dd4-a15a-487a-9adf-e5db321164b4"},{"name":"Assign Product (Coffee Beans - Whole) to Category (Coffee Supplies)","id":"3d7f78ae-ccff-41a6-930a-a9ebd0814821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffee_supplies\",\r\n \"ProductID\": \"whole_coffee_beans\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d7f78ae-ccff-41a6-930a-a9ebd0814821"},{"name":"Assign Product (Vanilla Flavoring Syrup) to Category (Coffee Supplies)","id":"229c03fb-da16-4d96-a69d-2eb17f68e85c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffee_supplies\",\r\n \"ProductID\": \"vanilla_flavoring_syrup\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"229c03fb-da16-4d96-a69d-2eb17f68e85c"},{"name":"Assign Product (White Chocolate Flavoring) to Category (Coffee Supplies)","id":"587c5051-d047-4f89-b789-a6f24125c0c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffee_supplies\",\r\n \"ProductID\": \"white_chocolate_flavoring\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"587c5051-d047-4f89-b789-a6f24125c0c2"},{"name":"Assign Product (Croissants) to Category (Coffeehouse Snacks)","id":"d82b273b-0f7d-4f02-b7e7-e317726e4738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CategoryID\": \"coffeehouse_snacks\",\r\n \"ProductID\": \"croissants\",\r\n \"ListOrder\": 1\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d82b273b-0f7d-4f02-b7e7-e317726e4738"},{"name":"Get Product Category Assignments","id":"55688ef9-4e9e-4551-b80b-9b806d20deac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/catalogs/{{catalog_id}}/categories/productassignments","urlObject":{"path":["v1","catalogs","{{catalog_id}}","categories","productassignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55688ef9-4e9e-4551-b80b-9b806d20deac"}],"id":"2a7a4619-1e74-4872-a91f-b7ed74989469","description":"Our products and categories were created in isolation from each other. In order to organize our catalog, we'll want to make assignments between our Product and Categories. By doing so, we are organizing our catalog into a sort of hierarchical structure.
\nFollow and run all the requests to assign each Product to a Category.
\n","event":[{"listen":"prerequest","script":{"id":"53303677-072c-4480-8646-16dd485c824e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dae1f8db-e837-4f39-b835-fbd14cfd880e","type":"text/javascript","exec":[""]}}],"_postman_id":"2a7a4619-1e74-4872-a91f-b7ed74989469"},{"name":"F. Create Price Schedules","item":[{"name":"Create Price Schedule (Bar Towels)","id":"3abaeb67-6680-408a-9988-c6a458bfa988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"bar_towels\",\r\n \"Name\": \"Bar Towels\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 12.99\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3abaeb67-6680-408a-9988-c6a458bfa988"},{"name":"Create Price Schedule (Barista Apron)","id":"896254ca-b8a6-4bf8-ba4c-ab422c0ddbaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"barista_apron\",\r\n \"Name\": \"Barista Apron\",\r\n \"ApplyTax\": false,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 24.99\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"896254ca-b8a6-4bf8-ba4c-ab422c0ddbaa"},{"name":"Create Price Schedule (Coffee Cups)","id":"991cb079-a9fd-4a88-9dd4-bd78d12d923e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"coffee_cups\",\r\n \"Name\": \"Coffee Cups\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 25,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 32.60\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"991cb079-a9fd-4a88-9dd4-bd78d12d923e"},{"name":"Create Price Schedule (Espresso Tamper - Metro Coffee)","id":"fdc0599b-35dc-4577-a2c5-9e0f0deca659","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"espresso_tamper_metrocoffee\",\r\n \"Name\": \"Espresso Tamper - Metro Coffee\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 49.98\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdc0599b-35dc-4577-a2c5-9e0f0deca659"},{"name":"Create Price Schedule (Espresso Tamper - Cloud Coffee)","id":"4b83f8ef-12b1-490a-b8c8-dfd1c468144c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"espresso_tamper_cloudcoffee\",\r\n \"Name\": \"Espresso Tamper - Cloud Coffee\",\r\n \"ApplyTax\": false,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 22.00\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b83f8ef-12b1-490a-b8c8-dfd1c468144c"},{"name":"Create Price Schedule (Ground Coffee Beans)","id":"95e5e281-2a36-4d87-8be0-82b838e9b2b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"ground_coffee_beans\",\r\n \"Name\": \"Coffee Beans - Ground\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 12.98\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95e5e281-2a36-4d87-8be0-82b838e9b2b9"},{"name":"Create Price Schedule (Vanilla Flavoring Syrup)","id":"dc463184-172a-4a49-8d7d-05abd4be4854","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"vanilla_flavoring_syrup\",\r\n \"Name\": \"Vanilla Flavoring Syrup\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 8.99\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc463184-172a-4a49-8d7d-05abd4be4854"},{"name":"Create Price Schedule (White Chocolate Flavoring)","id":"dd875442-5114-437f-a0d9-7566f3d513b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"white_chocolate_flavoring\",\r\n \"Name\": \"White Chocolatae Flavoring\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 9.99\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd875442-5114-437f-a0d9-7566f3d513b5"},{"name":"Create Price Schedule (Whole Coffee Beans)","id":"e19fff23-672d-4e4c-8f3c-1ba3a40ba732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"whole_coffee_beans\",\r\n \"Name\": \"Coffee Beans - Whole\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 12.98\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e19fff23-672d-4e4c-8f3c-1ba3a40ba732"},{"name":"Create Price Schedule (Croissants)","id":"e7c996ca-7555-4cc6-aa1a-a013e42e7203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"croissants\",\r\n \"Name\": \"Croissants - Pack of 8\",\r\n \"ApplyTax\": true,\r\n \"ApplyShipping\": true,\r\n \"MinQuantity\": 1,\r\n \"UseCumulativeQuantity\": false,\r\n \"RestrictedQuantity\": false,\r\n \"PriceBreaks\": [\r\n {\r\n \"Quantity\": 1,\r\n \"Price\": 25.98\r\n }\r\n ],\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7c996ca-7555-4cc6-aa1a-a013e42e7203"},{"name":"Get Price Schedules","id":"e9b7b4e6-a7a2-429a-b456-a794c6eace90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/priceschedules","urlObject":{"path":["v1","priceschedules"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9b7b4e6-a7a2-429a-b456-a794c6eace90"}],"id":"e02b6658-c30d-4905-9451-6a7f07c1e5db","description":"Now we have an organized product catalog, we need to create Price Schedules for each of the Products. For each of our products, we are going to create a price schedule that represents how much that product costs. However, for one product, we will make two price schedules. Each price schedule in this scenario will represent different prices for the different coffee shops (Buyers).
\n","event":[{"listen":"prerequest","script":{"id":"a9b2b7b3-d100-4149-9444-1faf234ae0f9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c282a0a3-333a-4418-834a-7cdd1c9daf7c","type":"text/javascript","exec":[""]}}],"_postman_id":"e02b6658-c30d-4905-9451-6a7f07c1e5db"},{"name":"G. Assign Products Default Price Schedules","item":[{"name":"Patch Default Price Schedule (Bar Towels)","id":"38ab1215-8b80-4a14-b469-18c7b32948e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"bar_towels\"\n}"},"url":"{{baseApiUrl}}/v1/products/bar_towels","urlObject":{"path":["v1","products","bar_towels"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38ab1215-8b80-4a14-b469-18c7b32948e5"},{"name":"Patch Default Price Schedule (Barista Apron)","id":"0770ace3-15b2-4755-9626-ac87daa45efc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"barista_apron\"\n}"},"url":"{{baseApiUrl}}/v1/products/barista_apron","urlObject":{"path":["v1","products","barista_apron"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0770ace3-15b2-4755-9626-ac87daa45efc"},{"name":"Patch Default Price Schedule (Coffee Cups)","id":"3f327dfc-6388-4f7e-a4c0-d2d9a7c8b9fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"coffee_cups\"\n}"},"url":"{{baseApiUrl}}/v1/products/coffee_cups","urlObject":{"path":["v1","products","coffee_cups"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f327dfc-6388-4f7e-a4c0-d2d9a7c8b9fe"},{"name":"Patch Default Price Schedule (Ground Coffee Beans)","id":"6488de36-e0a4-4687-b754-396b9440ef50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"ground_coffee_beans\"\n}"},"url":"{{baseApiUrl}}/v1/products/ground_coffee_beans","urlObject":{"path":["v1","products","ground_coffee_beans"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6488de36-e0a4-4687-b754-396b9440ef50"},{"name":"Patch Default Price Schedule (Vanilla Flavoring Syrup)","id":"a8c3e073-d79c-41ee-9640-e012014b72d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"vanilla_flavoring_syrup\"\n}"},"url":"{{baseApiUrl}}/v1/products/vanilla_flavoring_syrup","urlObject":{"path":["v1","products","vanilla_flavoring_syrup"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8c3e073-d79c-41ee-9640-e012014b72d5"},{"name":"Patch Default Price Schedule (White Chocolate Flavoring)","id":"f61b1152-8101-4d22-8743-631af7ac3037","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"white_chocolate_flavoring\"\n}"},"url":"{{baseApiUrl}}/v1/products/white_chocolate_flavoring","urlObject":{"path":["v1","products","white_chocolate_flavoring"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f61b1152-8101-4d22-8743-631af7ac3037"},{"name":"Patch Default Price Schedule (Whole Coffee Beans)","id":"e04701be-803d-45e8-81f0-dc99ae0339ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"whole_coffee_beans\"\n}"},"url":"{{baseApiUrl}}/v1/products/whole_coffee_beans","urlObject":{"path":["v1","products","whole_coffee_beans"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e04701be-803d-45e8-81f0-dc99ae0339ba"},{"name":"Patch Default Price Schedule (Croissants)","id":"cb0f40df-09b0-40e3-9afd-e9722b930bfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DefaultPriceScheduleID\": \"croissants\"\n}"},"url":"{{baseApiUrl}}/v1/products/croissants","urlObject":{"path":["v1","products","croissants"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb0f40df-09b0-40e3-9afd-e9722b930bfd"}],"id":"f637d220-20b8-4b01-97f0-ef6fb310bf1f","description":"One of the factors of product visibility is Product / Price Schedule assignments. If your goal is to have a product that has the same price across all your different buyers, then an easy way to accomplish this is to assign each Product a DefaultPriceScheduleID. This eliminates the need to make explicit Product/PriceSchedule/Buyer|UserGroup assignments.
Let's PATCH our products that have one price schedule and add the respective PriceScheduleID to the DefaultPriceScheduleID field.
In order for these Products to become available within the catalog, we need to assign each of these products to the catalog.
\nMake the requests, then List Product Catalog Assignments to see the list of assignments just created.
\n","event":[{"listen":"prerequest","script":{"id":"634bd901-a76c-4f7b-81db-b3bc5ef2f42d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f07ac770-a277-4efe-a881-3f4619ca45f0","type":"text/javascript","exec":[""]}}],"_postman_id":"4957529c-d221-460b-a051-fc4be4d32d99"},{"name":"I. Assign Unique Product Price Schedules to Buyer","item":[{"name":"Assign Price Schedule (Espresso Tamper) to Buyer (Metro Coffee)","id":"fc008eb3-9ab3-49e1-9c62-38930803ca86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"ProductID\": \"espresso_tamper\",\n\t\"BuyerID\": \"metro_coffee\",\n\t\"PriceScheduleID\": \"espresso_tamper_metrocoffee\"\n}"},"url":"{{baseApiUrl}}/v1/products/assignments","urlObject":{"path":["v1","products","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc008eb3-9ab3-49e1-9c62-38930803ca86"},{"name":"Assign Price Schedule (Espresso Tamper) to Buyer (Cloud Coffee)","id":"8d59cd93-7b53-4e7e-9c93-e9d9dee34191","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ProductID\": \"espresso_tamper\",\n\t\"BuyerID\": \"cloud_coffee\",\n\t\"PriceScheduleID\": \"espresso_tamper_cloudcoffee\"\n}"},"url":"{{baseApiUrl}}/v1/products/assignments","urlObject":{"path":["v1","products","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d59cd93-7b53-4e7e-9c93-e9d9dee34191"},{"name":"List Price Schedule Assignments","id":"ebfa5234-5237-497b-8e8f-4f1183594b92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/products/assignments","description":"Here we see the two Product / Party / PriceSchedule assignments we just made. This action created a relationship between a Party, a Product and a Price Schedule.
\n","urlObject":{"path":["v1","products","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebfa5234-5237-497b-8e8f-4f1183594b92"},{"name":"Get Products as Buyer (Metro Coffee) User (Bill)","id":"52789414-90bd-40b2-b0a6-4086fa1b729d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products","description":"If we List products as a Metro Coffee Buyer User, we see the Metro Coffee Espresso Tamper Price Schedule returned.
\n","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"52789414-90bd-40b2-b0a6-4086fa1b729d"},{"name":"Get Products as Buyer (Cloud Coffee) User (Grace)","id":"f1e7ecde-60f0-4d05-baaf-c72ef25bc7eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_grace}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products","description":"If we List products as a Cloud Coffee Buyer User, we see the Cloud Coffee Espresso Tamper Price Schedule returned.
\n","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1e7ecde-60f0-4d05-baaf-c72ef25bc7eb"}],"id":"8bb63d81-cb70-48fb-81df-f9a490e20d48","description":"For the product under which we created two price schedules (to differentiate pricing between buyers), we need to create a special relationship between the product /price schedule/ buyer. To do this, we will create a Price Schedule Buyer assignment.
\nAfter we make the assignments, we'll List Price Schedule Assignments to see those assignments we just created and after that we'll list products as different buyer users to see those different prices reflected. In order to do this, we'll need to get different user tokens and add those to our environment variables.
\nHead back to the Recurring Authentication section and run requests to get user tokens for both Bill and Grace. Once you have those tokens, add them to your environment variables under buyer_token_bill and buyer_token_grace.
Now, make the requests to assign each respective price schedule to buyer.
\n","event":[{"listen":"prerequest","script":{"id":"935d1535-d2e8-49b5-9481-bc724c8e1689","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4994b8c-5d2e-4f2c-8931-9b63f1a22885","type":"text/javascript","exec":[""]}}],"_postman_id":"8bb63d81-cb70-48fb-81df-f9a490e20d48"},{"name":"J. Patch Catalog to Change Visibility Rules","item":[{"name":"Patch Catalog (nlc_catalog) / Buyer (Metro Coffee) Assignment","id":"caffc614-2499-4cf1-8148-ff440996add9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CatalogID\": \"nlc_catalog\",\r\n \"BuyerID\": \"metro_coffee\",\r\n \"ViewAllCategories\": false,\r\n \"ViewAllProducts\": false\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/assignments","urlObject":{"path":["v1","catalogs","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"caffc614-2499-4cf1-8148-ff440996add9"},{"name":"Patch Catalog (nlc_catalog) / Buyer (Cloud Coffee) Assignment","id":"94d3fde6-8896-4793-b6b3-3e4ddae0aec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CatalogID\": \"nlc_catalog\",\r\n \"BuyerID\": \"cloud_coffee\",\r\n \"ViewAllCategories\": false,\r\n \"ViewAllProducts\": false\r\n}"},"url":"{{baseApiUrl}}/v1/catalogs/assignments","urlObject":{"path":["v1","catalogs","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"94d3fde6-8896-4793-b6b3-3e4ddae0aec8"},{"name":"Get Products as Buyer (Metro Coffee) User (Bill)","id":"84a6c5e9-0416-461c-8db5-88d472524474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"84a6c5e9-0416-461c-8db5-88d472524474"}],"id":"7f772d56-0bc1-418b-a40a-3d165bd8885f","description":"Now that we have basic product visibility working - let's refine it.
\nPATCH the Catalog Buyer Assignments to both have ViewAllCategories and ViewAllProducts set to false. After thirty seconds or so, you should see in the last request, that Bill calling me/products returns only the product that has an explicit assignment.
Now, if we List Products as a Cloud Coffee user, we should see all the products displaying again - because we made the explicit assignment between the Categories and Buyers.
\nNOTE: If you are NOT seeing all products you would expect, it may be related to a known caching issue. If this is the case, you can do one of two things:\n 1. Patch all of the products and change something superficial (e.g. punctuation in the description)\n 2. Reach out to a platform developer and have them trigger a rebuild of your product catalog.
\n","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c96d20e9-b375-4812-871b-819904f656a5"}],"id":"4ec249ac-57bd-4fee-bea8-6b8cd9ffff86","description":"Next, we are going to make different Categories visible to each of the buyers by assigning the Categories directly to the Buyers. This is going to allow the Buyer to see the category that's assigned.
\nWe are going to assign all categories to all buyers - but with Metro Coffee, we are going to make sure the assignment for the Coffee Supplies category has ViewAllProducts set to false. This way, we can control Product visibility by either individual Buyer User Group or Buyer User. In our case, we will control visibility at the Buyer User Group level.
To further refine visibility of Products for Metro Coffee Buyer Users, we will have to assign Products to Buyer User Groups. We are doing this as a result of defining ViewAllProducts: false on the Category / Buyer assignment.
We want visibility as follows:\nMetro Coffee - Uptown: all products\nMetro Coffee - Northeast: all products except the Flavoring Syrups (Vanilla, White Chocolate)
\nAt the end of this group of requests, we will be Listing products as Metro Coffee - Uptown user Jill. Let's get an authentication token for her, and add it to our environment variables. Go back to the Recurring Auth folder, get Jill's token and go ahead and add it.
\n","event":[{"listen":"prerequest","script":{"id":"572a1be5-20dd-4a51-83ef-581dac18a7c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b485156f-7846-4a53-8fec-56731810d78b","type":"text/javascript","exec":[""]}}],"_postman_id":"b80ac052-400b-4f32-87c8-c90c462dcd2e"}],"id":"79630337-4f7f-4b1d-9ca5-bfd7ff65a7ed","description":"Products are priced (or unpriced) goods that can be offered to Buyers for placement on Orders. A Product can belong to any number of Catalogs, and a Catalog can be organized into hierarchical Categories to any arbitrary depth. Catalogs are assigned to Buyers, though visibility and pricing may vary by Buyer, User Group, Category, or individual Product. Pricing may include quantity breaks (collectively called a Price Schedule), and Price Schedules may be shared with multiple Products. User-selected Specs, which may include price markups, can be assigned to Products, enabling Buyer configurability at the time of ordering.
\n","event":[{"listen":"prerequest","script":{"id":"790284d8-eadf-47d3-8bca-8a60ec84b7ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31622aeb-53ba-4880-9c57-69039038cb6f","type":"text/javascript","exec":[""]}}],"_postman_id":"79630337-4f7f-4b1d-9ca5-bfd7ff65a7ed"},{"name":"7. Orders and Fulfillment","item":[{"name":"A. Shop Products","item":[{"name":"List Products as Buyer (Metro Coffee) User (Bill)","id":"c82a7ad6-e135-474a-a716-7fdbbfca7c88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c82a7ad6-e135-474a-a716-7fdbbfca7c88"}],"id":"0de96393-6afa-47a2-9f19-aba8f50e33dc","description":"To 'Shop' for a product, make a List call to me/products to see what products are available to the buyer user.
In order to pay for the products we will be ordering, we must create a payment method. Let's create a fake credit card to be used on Bill's order.
\nAdd the resulting credit_card_id to the environment variables.
Add the resulting orderID to the environment variables.
Now, let's create a line item consisting of one product and add it to our order.
\nAdd the resulting line item lineItemID to the environment variables.
We can now review the line items that have been added to this order.
\n","urlObject":{"path":["v1","orders","outgoing","{{orderID}}","lineitems"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d816fa14-160a-429e-9431-aa7a7de031b2"},{"name":"List My Addresses","id":"e4098fab-a835-4030-8984-b7e7183ab4e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/addresses","description":"We will need to set shipping and billing addresses for this order, so let's lake a look at the addresses available to this buyer user.
\n","urlObject":{"path":["v1","me","addresses"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4098fab-a835-4030-8984-b7e7183ab4e8"},{"name":"Set Shipping and Billing Address","id":"ed820240-490c-40a7-ac9a-7dc8cc074053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"ShippingAddressID\": \"northeast\",\n\t\"BillingAddressID\": \"northeast\"\n}"},"url":"{{baseApiUrl}}/v1/orders/outgoing/{{orderID}}","description":"Here we will PATCH the order to set a shipping and billing address for the order. We will use Metro Coffee - Northeast's address for this.
Now, we will create a payment method on the order to pay for it.
\nAt this stage, the payment will display as \"Accepted\": false, but in the next section we will process the credit card to update this.
Add the resulting paymentID to the environment variables.
You can now list the payments for this order to review what was added.
\n","urlObject":{"path":["v1","orders","outgoing","{{orderID}}","payments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6155f77-9847-45b3-a557-1ba656861611"}],"id":"a7983375-57b9-4b67-a829-a6e591ff7192","description":"In this section, we will create an order, add a line item to the order, and run a GET request to review the line items on the order. We will also review our addresses and patch the order to set a shipping and billing address. Finally, we will post a payment method to the order and review the payments on the order.
\nTo get started, we will create an outgoing order. Orders are considered \"outgoing\" from the perspective of a buyer user, and \"incoming\" from the perspective of a seller user. When introducing the concept of a supplier user, orders that suppliers receive from customers are referred to as \"incoming\" while orders that go sellers are regaraded as \"outgoing.\" In this instance, we are only focused an order that a buyer user is creating and will POST an outgoing order.
\n","event":[{"listen":"prerequest","script":{"id":"f1ad2ff9-bdff-44c8-a9ad-8f7d68e8c693","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e680dd1-5a82-4f79-a950-ec345143bcf2","type":"text/javascript","exec":[""]}}],"_postman_id":"a7983375-57b9-4b67-a829-a6e591ff7192"},{"name":"D. Process Credit Card","item":[{"name":"Create A New Payment Transaction (Authorize)","id":"b02b9434-8117-4899-87c2-b7d9fc0022d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"authorize\",\r\n \"Type\": \"CreditCard\",\r\n \"DateExecuted\": \"2020-04-23T00:00:00-06:00\",\r\n \"Succeeded\": true,\r\n \"ResultCode\": \"I00001\",\r\n \"ResultMessage\": \"Successful\"\r\n}"},"url":"{{baseApiUrl}}/v1/orders/incoming/{{orderID}}/payments/{{paymentID}}/transactions","description":"This step will authorize the credit card to ensure it is valid.
\n","urlObject":{"path":["v1","orders","incoming","{{orderID}}","payments","{{paymentID}}","transactions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b02b9434-8117-4899-87c2-b7d9fc0022d3"},{"name":"Create A New Payment Transaction (Capture)","id":"d9dfe656-acb1-4c7a-a128-7f1ea6bf7d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"capture\",\r\n \"Type\": \"CreditCard\",\r\n \"DateExecuted\": \"2020-04-23T00:00:00-06:00\",\r\n \"Succeeded\": true,\r\n \"ResultCode\": \"I00001\",\r\n \"ResultMessage\": \"Successful\"\r\n}"},"url":"{{baseApiUrl}}/v1/orders/incoming/{{orderID}}/payments/{{paymentID}}/transactions","description":"This step will capture the payment, which is typically done when the order ships.
\n","urlObject":{"path":["v1","orders","incoming","{{orderID}}","payments","{{paymentID}}","transactions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9dfe656-acb1-4c7a-a128-7f1ea6bf7d2d"},{"name":"Patch Payment to be Accepted (Mimicking successful CC charge)","id":"3d8d7967-c68d-400d-86f3-b9fdec201f7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Accepted\": true\r\n}"},"url":"{{baseApiUrl}}/v1/orders/incoming/{{orderID}}/payments/{{paymentID}}","description":"Now that we have both authorized and captured this payment, we will PATCH the Payment to have Accepted: true, mimicking a succesful credit card transaction.
Now that we have added the payment method, let's review this from an Admin user's perspective.
\nA typical flow for capturing payment is to first authorize the payment, and then capture it. Generally payment is captured after a shipment has been made, but for this exercise, we will authorize and capture the payment right away.
\nBecause we are viewing this from an Admin user's perspective, notice that the Orders we are wokring with are considered \"Incoming\" orders instead of \"Outgoing.\"
\n","event":[{"listen":"prerequest","script":{"id":"169a4016-ce40-4c69-9b18-d32cb911321b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4ed0ca04-0865-4648-962e-a5f09a450f61","type":"text/javascript","exec":[""]}}],"_postman_id":"4ab4bd0f-0ae8-4a01-bbb4-2e4762f14d4a"},{"name":"E. Submit an Order","item":[{"name":"Submit Your Order","id":"4a6499f0-55e1-4406-86a4-818a48d1aa3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{baseApiUrl}}/v1/orders/outgoing/{{orderID}}/submit","urlObject":{"path":["v1","orders","outgoing","{{orderID}}","submit"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a6499f0-55e1-4406-86a4-818a48d1aa3e"}],"id":"ff6c8243-c952-4626-9693-f1279fa98d3b","description":"Our order now has line items, and the payment has been authorized and captured. Let's submit the order!
\n","event":[{"listen":"prerequest","script":{"id":"de93b5c3-9d32-4913-82b5-ba4f8bdec38b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4706a78d-a690-4fb9-9dd2-c9fffa550b26","type":"text/javascript","exec":[""]}}],"_postman_id":"ff6c8243-c952-4626-9693-f1279fa98d3b"},{"name":"F. Create Order Shipment","item":[{"name":"Create Order Shipment","id":"b92d5f92-3193-49a6-9b48-c42faf41f060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"bill_order_shipment\",\r\n \"BuyerID\": \"metro_coffee\",\r\n \"Shipper\": null,\r\n \"DateShipped\": null,\r\n \"DateDelivered\": null,\r\n \"TrackingNumber\": null,\r\n \"ToAddressID\": \"northeast\"\r\n}"},"url":"{{baseApiUrl}}/v1/shipments","description":"Add the resulting shipmentID to the environment variables.
This step will indicate which line item we are updating and how many of that item is included in this shipment.
\n","urlObject":{"path":["v1","shipments","{{shipmentID}}","items"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9224ab76-7480-44a5-822b-70b3e520b4df"},{"name":"List Shipments for this Order","id":"f631b327-eaec-4b17-849d-c865c2828d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseApiUrl}}/v1/orders/Incoming/{{orderID}}/shipments","description":"This will get us a list of any shipments that have been created for this order.
\n","urlObject":{"path":["v1","orders","Incoming","{{orderID}}","shipments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f631b327-eaec-4b17-849d-c865c2828d3c"},{"name":"List Shipment Items for this Shipment","id":"817b0eea-3777-4cfd-82e0-9f29075ff607","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/shipments/{{shipmentID}}/items","description":"This will get us a list of any line items included in the shipment we created.
\n","urlObject":{"path":["v1","shipments","{{shipmentID}}","items"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"817b0eea-3777-4cfd-82e0-9f29075ff607"},{"name":"Get Order (that was just shipped)","id":"859bb585-582c-42e2-9d65-452aeccc9fec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/orders/incoming/{{orderID}}","description":"Now we can review the order, which now has a Shipment with a Shipment Item.
\nObserve that the Status is still Open. This is because we haven't give the order a DateShipped yet. Let's PATCH the order and give it a DateShipped.
Now we observe the order has a status of Completed. You've officially placed your first order through OrderCloud!
Now that we have a submitted order, it's time to create a shipment. After creating the shipment, we will then create shipment items (containing the line items from the order), and then we will ship the order.
\nPlease note that Order Shipments must be created with ShippedDate: null, or you will have issues 'closing' the order.
Now that our product catalogs are all complete with products, categories and refined visibility, we are ready to place an order! In this section, we will get a list of products available for a buyer user and create a credit card payment method to pay for the products. Then, we will explore how to create an order, add line items to the order, process the payment, and submit the order. Once this has been submitted, we will create a shipment and indicate which items belong to that shipment.
\nTo get started, we will place an order with the Metro Coffee - Northeast Buyer User Bill. Follow through these requests to complete the order.
\n","event":[{"listen":"prerequest","script":{"id":"37fc0058-2e0d-4ac5-8363-4a4732759f7c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"036f480c-7e9a-415c-9cb6-c7dae5bae801","type":"text/javascript","exec":[""]}}],"_postman_id":"aaa1138d-a3c6-48c0-8a2d-f8fb39db6c79"},{"name":"8. Promotions and Approval Rules","item":[{"name":"A. Create Promotion","item":[{"name":"Create Promotion (BOGO Whole Coffee Beans)","id":"9db99708-e756-4093-ac32-9390d9aff457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"whole_coffee_bean_BOGO\",\r\n \"Code\": \"BOGO\",\r\n \"Name\": \"BOGO Whole Coffee Beans\",\r\n \"RedemptionLimit\": null,\r\n \"RedemptionLimitPerUser\": 2,\r\n \"Description\": \"Buy one of our premium whole coffee bean 1lb bags, get one free!\",\r\n \"FinePrint\": \"Limit two per customer.\",\r\n \"StartDate\": \"2019-10-01T00:00:00-06:00\",\r\n \"ExpirationDate\": \"2025-11-01T00:00:00-06:00\",\r\n \"EligibleExpression\": \"items.quantity(ProductID = 'whole_coffee_beans') > 1\",\r\n \"ValueExpression\": \"items.total(ProductID = 'whole_coffee_beans') / items.quantity(ProductID = 'whole_coffee_beans')\",\r\n \"CanCombine\": false,\r\n \"AllowAllBuyers\": true,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/promotions","urlObject":{"path":["v1","promotions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9db99708-e756-4093-ac32-9390d9aff457"},{"name":"Create Promotion ($5 Off Order When you order Bar Towels)","id":"eb7acb40-fa1f-4992-b886-356c75301fa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"5off\",\r\n \"Code\": \"5OFF\",\r\n \"Name\": \"$5 Off Order\",\r\n \"RedemptionLimit\": null,\r\n \"RedemptionLimitPerUser\": null,\r\n \"Description\": \"Get $5 off your order total when you order at least 1 Bar Towel!\",\r\n \"FinePrint\": \"Metro Coffee users only.\",\r\n \"StartDate\": \"2019-10-01T00:00:00-06:00\",\r\n \"ExpirationDate\": \"2025-11-01T00:00:00-06:00\",\r\n \"EligibleExpression\": \"items.any(ProductID = 'bar_towels')\",\r\n \"ValueExpression\": \"5\",\r\n \"CanCombine\": false,\r\n \"AllowAllBuyers\": false,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/promotions","urlObject":{"path":["v1","promotions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb7acb40-fa1f-4992-b886-356c75301fa9"},{"name":"List Promotions as Buyer (Metro Coffee) User (Bill)","id":"acb4cc07-6715-48c2-a91d-6e041e987fbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/me/promotions","urlObject":{"path":["v1","me","promotions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"acb4cc07-6715-48c2-a91d-6e041e987fbe"},{"name":"Assign Promotion (5off) to Buyer (Metro Coffee)","id":"52e70980-84fc-47b0-a0eb-ea2e663b6820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"PromotionID\": \"5off\",\r\n \"BuyerID\": \"metro_coffee\",\r\n}"},"url":"{{baseApiUrl}}/v1/promotions/assignments","urlObject":{"path":["v1","promotions","assignments"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"52e70980-84fc-47b0-a0eb-ea2e663b6820"},{"name":"List Promotions as Buyer (Metro Coffee) User (Bill)","id":"0bf1c5f0-4719-4013-b53a-aeb7d403292e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/me/promotions","urlObject":{"path":["v1","me","promotions"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bf1c5f0-4719-4013-b53a-aeb7d403292e"}],"id":"0c819166-8404-4a00-9ed9-0499260d0186","_postman_id":"0c819166-8404-4a00-9ed9-0499260d0186","description":""},{"name":"B. Redeem Promotion on an Order","item":[{"name":"Create an Outogoing Order","id":"6f1ea015-848e-43ba-8da5-322c47605fe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"bill_promo_order\"\r\n}"},"url":"{{baseApiUrl}}/v1/orders/outgoing","description":"Make sure to update orderID in the environment variables.
Make sure to update the lineItemID in the environment variables.
Make sure to update paymentID in the environment variables.
Make sure to change the buyerID in the environment variables to be metro_coffee before you send this request. This will ensure the approval rule is put on the correct buyer.
Observe order Status is now AwaitingApproval. This means that the order requires approval before it can be submitted.
Notice that the order status now reflects Open.
Make sure to update shipmentID in the environment variables.
Now, you'll notice even though we have made a shipment, the Status is still Open. This is because in order for an order status to be Complete, you must have shipped ALL line items within an order.
This order we will leave as Status: Open.
Next, we are going to create an two Ordercloud Promotions as well as an Approval Rule. Then, we will redeem a promotion on an order, and hit the approval criteria so that it must go through approval. After that, we will pretend that our supplier only has some of the inventory required to fulfill the order, so we will create a partial order shipment.
\nFollow through the requests to complete this prompt.
\n","event":[{"listen":"prerequest","script":{"id":"2ea68804-0ff6-4282-8dd6-b031da4ff627","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a363ef26-78dd-4a1d-9572-5c415e9f8c30","type":"text/javascript","exec":[""]}}],"_postman_id":"76d4eaf9-ed42-4eee-8e1a-acb94e5045c8"},{"name":"9. Product XP Filtering and Faceting","item":[{"name":"A. Add 2 XP Values to All Products","item":[{"name":"Add xp.Brand and xp.Size to Coffee Cups","id":"7474219b-54d3-444c-80ea-74d717d191c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Uline\",\n\t\t\"Size\": \"12oz\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/coffee_cups","urlObject":{"path":["v1","products","coffee_cups"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7474219b-54d3-444c-80ea-74d717d191c0"},{"name":"Add xp.Brand and xp.Size to Coffee Beans - Whole","id":"adcd677c-974b-46e1-85c7-d97a0ea34b8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Northern Lights Coffee\",\n\t\t\"Size\": \"1lb\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/whole_coffee_beans","urlObject":{"path":["v1","products","whole_coffee_beans"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"adcd677c-974b-46e1-85c7-d97a0ea34b8d"},{"name":"Add xp.Brand and xp.Size to Coffee Beans - Ground","id":"f628baf0-0e93-4b62-a351-4a250d6cc09d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Northern Lights Coffee\",\n\t\t\"Size\": \"1lb\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/ground_coffee_beans","urlObject":{"path":["v1","products","ground_coffee_beans"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f628baf0-0e93-4b62-a351-4a250d6cc09d"},{"name":"Add xp.Brand and xp.Size to Barista Apron","id":"10b64e4d-c279-4049-9f5c-7392a8486f81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Uline\",\n\t\t\"Size\": \"One-Size\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/barista_apron","urlObject":{"path":["v1","products","barista_apron"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"10b64e4d-c279-4049-9f5c-7392a8486f81"},{"name":"Add xp.Brand to Espresso Tamper","id":"2d40dfe7-087e-42df-baf4-73ab8d6aea92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Benicci\",\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/espresso_tamper","urlObject":{"path":["v1","products","espresso_tamper"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d40dfe7-087e-42df-baf4-73ab8d6aea92"},{"name":"Add xp.Brand and xp.Size to Vanilla Flavoring Syrup","id":"aad23ab5-9dbb-4c19-8449-5450c845c7db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Torani\",\n\t\t\"Size\": \"750mL\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/vanilla_flavoring_syrup","urlObject":{"path":["v1","products","vanilla_flavoring_syrup"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aad23ab5-9dbb-4c19-8449-5450c845c7db"},{"name":"Add xp.Brand and xp.Size to White Chocolate Flavoring","id":"95dcd385-18b0-482e-b0ed-34f6b6a1c558","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Torani\",\n\t\t\"Size\": \"750mL\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/white_chocolate_flavoring","urlObject":{"path":["v1","products","white_chocolate_flavoring"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95dcd385-18b0-482e-b0ed-34f6b6a1c558"},{"name":"Add xp.Brand and xp.Size to Bar Towels","id":"d2c1ed6a-ac80-4564-911c-26bdf61b42d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Uline\",\n\t\t\"Size\": \"10x10in\"\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/bar_towels","urlObject":{"path":["v1","products","bar_towels"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2c1ed6a-ac80-4564-911c-26bdf61b42d9"},{"name":"Add xp.Brand to Croissants","id":"f344387e-9e27-4d15-a603-7fd987501513","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"xp\": {\n\t\t\"Brand\": \"Northern Lights Coffee\",\n\t}\n}"},"url":"{{baseApiUrl}}/v1/products/croissants","urlObject":{"path":["v1","products","croissants"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f344387e-9e27-4d15-a603-7fd987501513"}],"id":"d693f907-8127-4b4a-a027-d08516547d9f","description":"Let's add two XP values to each of our products: Brand and Size.
\n","event":[{"listen":"prerequest","script":{"id":"1e89d21b-01ed-480a-8a67-2e10b2d26705","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bbfaba23-62b5-4af2-a87e-36044f21b9e5","type":"text/javascript","exec":[""]}}],"_postman_id":"d693f907-8127-4b4a-a027-d08516547d9f"},{"name":"B. Search products for new XP Values","item":[{"name":"Add Index for xp.Size","id":"318bdf44-a858-4886-8f45-d63a1f801bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"Key\": \"Size\",\n\t\"ThingType\": \"Product\"\n}"},"url":"{{baseApiUrl}}/v1/xpindices","urlObject":{"path":["v1","xpindices"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"318bdf44-a858-4886-8f45-d63a1f801bd6"},{"name":"Search Products with 'Size' of '12oz'","id":"e2b7dc9d-e6bf-48c9-8121-7c3679116a98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products?xp.Size=12oz","description":"Now, if we search products with Size: 12oz, we should see our products with that XP value.
Now that our products have XP, we are able to search based on these XP values. Read more about the introduction of Premium Search here, and the current capabilities of Premium Search here.
\n","event":[{"listen":"prerequest","script":{"id":"bfd52fb7-8433-40f0-ab93-fa4b67b1c00c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a294d9c0-af6f-474c-a411-cdbd272161dd","type":"text/javascript","exec":[""]}}],"_postman_id":"02dd3d90-cf1c-42bf-bd89-e704bdae4c72"},{"name":"C. Add Product Facets","item":[{"name":"Create 'Brand' Product Facet","id":"3e524064-21f2-4917-a2c8-4810020c3572","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"Brand\",\r\n \"Name\": \"Brand\",\r\n \"XpPath\": \"Brand\",\r\n \"ListOrder\": 1,\r\n \"MinCount\": 0,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/productfacets","urlObject":{"path":["v1","productfacets"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e524064-21f2-4917-a2c8-4810020c3572"},{"name":"Create 'Size' Product Facet","id":"8ad6eec2-3a6a-4507-ba35-2df8b8222f8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"Size\",\r\n \"Name\": \"Size\",\r\n \"XpPath\": \"Size\",\r\n \"ListOrder\": 2,\r\n \"MinCount\": 0,\r\n \"xp\": {}\r\n}"},"url":"{{baseApiUrl}}/v1/productfacets","urlObject":{"path":["v1","productfacets"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ad6eec2-3a6a-4507-ba35-2df8b8222f8a"},{"name":"List Facets","id":"bbeac5dd-1876-4dec-93ec-8320d6cf2bec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/productfacets","urlObject":{"path":["v1","productfacets"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbeac5dd-1876-4dec-93ec-8320d6cf2bec"},{"name":"Search Products (Observe Facets at the top)","id":"37de4bbe-25a6-453e-85c6-ccf6edaf4d32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_bill}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/me/products","description":"Notice the facets were returned at the top!
\n","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"37de4bbe-25a6-453e-85c6-ccf6edaf4d32"}],"id":"70ee7105-2b18-4a53-a328-1dabe8a38a3e","description":"Let's add product facets. Facets are a list of the potential fields and values that you can filter on. These are often displayed in a column on the left on ecommerce websites. Now that premium search comes standard with every new Org, we should see facets returned at the top of any me/products call.
When returning facets, if there is no XpPath defined and there is no non-xp property related to the facet, OrderCloud will look at xp.[facetID] so you can also include the xp field as the ID. The facets that are returned at the top of the me products list will typically be displayed on the UI. When a facet it selected it is typically added as a filter on another me list products call which will then return facets available only under that filter.
\n","event":[{"listen":"prerequest","script":{"id":"fae66bc3-c264-43ee-a6be-3115afe2936f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62b8700b-ba47-4498-a2d0-c86f081e3df6","type":"text/javascript","exec":[""]}}],"_postman_id":"70ee7105-2b18-4a53-a328-1dabe8a38a3e"}],"id":"69045bf2-1d10-40a9-ae48-518a3e90faac","description":"Let's dive into Product XP Filtering and Faceting. Read more about XP and best practices here.
\n","event":[{"listen":"prerequest","script":{"id":"7790a302-fdfe-46e3-84de-03ce553aef38","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c1090f32-6335-44dc-818a-7b07e8dff34a","type":"text/javascript","exec":[""]}}],"_postman_id":"69045bf2-1d10-40a9-ae48-518a3e90faac"},{"name":"10. Impersonation","item":[{"name":"Impersonate Buyer User as Admin User","item":[{"name":"List Admin User (To gather ID)","id":"c12d545f-02c8-47bc-ab85-225795701089","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{baseApiUrl}}/v1/me","description":"In order to create an impersonation config for the admin user, you are going to need the adminUserID. To get your admin user's ID, perform a GET v1/me call using your admin user's token, and add the resulting ID to your environment variables as adminUserID.
Impersonation can be done with either an Admin user impersonating a Buyer User, or a Buyer User Impersonating another Buyer User. First, we'll set up a config for an Admin User to impersonate a Buyer User.
\n","event":[{"listen":"prerequest","script":{"id":"427d940f-bd97-4faa-9bbd-f7199323c1b2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4e891818-a596-4d83-bebe-c45e90cfc9d8","type":"text/javascript","exec":[""]}}],"_postman_id":"0916f583-6dc2-4dd0-93ad-684ec0d3adaa"},{"name":"Impersonate Buyer User As Another Buyer User","item":[{"name":"List Admin Users","id":"3d9eb558-f872-4c9c-b661-488e8cf5d38a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/adminusers","urlObject":{"path":["v1","adminusers"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d9eb558-f872-4c9c-b661-488e8cf5d38a"},{"name":"Create Impersonation Config (Uptown impersonate Northeast)","id":"d1f10c26-8068-4764-9549-6c95fc6316ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"uptown_impersonate_northeast\",\r\n \"ImpersonationBuyerID\": \"metro_coffee\",\r\n \"ImpersonationGroupID\": \"uptown\",\r\n \"ImpersonationUserID\": null,\r\n \"BuyerID\": \"metro_coffee\",\r\n \"GroupID\": \"northeast\",\r\n \"UserID\": null,\r\n \"SecurityProfileID\": \"buyerProfile1\",\r\n \"ClientID\": \"{{client_id}}\"\r\n}"},"url":"{{baseApiUrl}}/v1/impersonationconfig","urlObject":{"path":["v1","impersonationconfig"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1f10c26-8068-4764-9549-6c95fc6316ec"},{"name":"Get Buyer Token as another Buyer User","id":"c951efc5-0d05-4554-b224-83b921ca314d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{buyer_token_jill}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ClientID\": \"{{clientID_buyer}}\",\n\t\"Roles\": [\n\t\t\"MeAddressAdmin\",\n \"MeAdmin\",\n \"MeCreditCardAdmin\",\n \"MeXpAdmin\",\n \"Shopper\"\n ]\n}"},"url":"{{baseApiUrl}}/v1/buyers/{{buyerID}}/users/bill/accesstoken","urlObject":{"path":["v1","buyers","{{buyerID}}","users","bill","accesstoken"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c951efc5-0d05-4554-b224-83b921ca314d"}],"id":"3ab17ae1-22a0-40e4-a1cb-7b2055ee0a0f","description":"As a buyer user in group A , another user in group B calls me up and wants me to create and order on their behalf. (e.g. Customer Service Rep takes order for one of their stores) check out the impersonation guide.
\nLets set up an Impersonation Config to allow users in Metro Coffee - Uptown to impersonate users in Metro Coffee - Northeast.
\n","event":[{"listen":"prerequest","script":{"id":"9444db95-b647-4c10-8b42-f95902509a80","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b4e4a4fd-21dd-4176-b086-8a19124d6500","type":"text/javascript","exec":[""]}}],"_postman_id":"3ab17ae1-22a0-40e4-a1cb-7b2055ee0a0f"},{"name":"Set Up Default Context User","item":[{"name":"List API Clients","id":"58ea5a5b-2b9f-4f04-8c56-bcedcc55acdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/apiclients","urlObject":{"path":["v1","apiclients"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58ea5a5b-2b9f-4f04-8c56-bcedcc55acdd"},{"name":"Put Seller API Client with DefaultContextUserName (nlc_admin)","id":"c55b2d3a-ee08-47a4-8303-e71437bba731","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"4ACDE590-9B23-4CF6-AAFF-BC084FC4178F\",\r\n \"ClientSecret\": null,\r\n \"AccessTokenDuration\": 500,\r\n \"Active\": true,\r\n \"AppName\": \"Seller App\",\r\n \"RefreshTokenDuration\": 0,\r\n \"DefaultContextUserName\": \"nlcadmin\",\r\n \"xp\": null,\r\n \"AllowAnyBuyer\": false,\r\n \"AllowAnySupplier\": false,\r\n \"AllowSeller\": true,\r\n \"IsAnonBuyer\": false,\r\n \"AssignedBuyerCount\": 0,\r\n \"AssignedSupplierCount\": 0\r\n}"},"url":"{{baseApiUrl}}/v1/apiclients/53181F89-0251-4483-90A8-178379A11FBD","urlObject":{"path":["v1","apiclients","53181F89-0251-4483-90A8-178379A11FBD"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c55b2d3a-ee08-47a4-8303-e71437bba731"},{"name":"Put Buyer API Client with DefaultContextUserName (jill)","id":"40dfcb40-e98e-440b-b899-7bb811e7f8e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"746DEC92-6811-492D-9467-30F2F5F31CB9\",\r\n \"ClientSecret\": null,\r\n \"AccessTokenDuration\": 500,\r\n \"Active\": true,\r\n \"AppName\": \"Buyer App\",\r\n \"RefreshTokenDuration\": 0,\r\n \"DefaultContextUserName\": \"jill\",\r\n \"xp\": null,\r\n \"AllowAnyBuyer\": true,\r\n \"AllowAnySupplier\": false,\r\n \"AllowSeller\": false,\r\n \"IsAnonBuyer\": false,\r\n \"AssignedBuyerCount\": 0,\r\n \"AssignedSupplierCount\": 0\r\n}"},"url":"{{baseApiUrl}}/v1/apiclients/{{clientID_buyer}}","urlObject":{"path":["v1","apiclients","{{clientID_buyer}}"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40dfcb40-e98e-440b-b899-7bb811e7f8e1"}],"id":"10b9020e-4810-4a6b-bc74-c7c3a2da3a9d","description":"Sometimes integrations with a 3rd party tech teams needs to be made, and they need access to the orders info, so they can update info on their system automatically. Configure a default context user, that the 3rd party team can use.
\n","event":[{"listen":"prerequest","script":{"id":"0c283cf8-f2f3-41d5-9b2a-bbd4c478c116","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"374c0c49-7d07-467b-8974-2c2259faaa37","type":"text/javascript","exec":[""]}}],"_postman_id":"10b9020e-4810-4a6b-bc74-c7c3a2da3a9d"},{"name":"Create New 'Integrations' API Client","item":[{"name":"Create API Client","id":"b31b0d55-c0ca-4c0e-8b6f-9c33cbb4fb4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ClientSecret\": \"super-secret-and-secure-client-secret-key\",\r\n \"AccessTokenDuration\": 500,\r\n \"Active\": true,\r\n \"AppName\": \"Integrations\",\r\n \"RefreshTokenDuration\": 0,\r\n \"DefaultContextUserName\": null,\r\n \"xp\": {},\r\n \"AllowAnyBuyer\": false,\r\n \"AllowAnySupplier\": false,\r\n \"AllowSeller\": true,\r\n \"IsAnonBuyer\": false\r\n}"},"url":"{{baseApiUrl}}/v1/apiclients","urlObject":{"path":["v1","apiclients"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b31b0d55-c0ca-4c0e-8b6f-9c33cbb4fb4b"},{"name":"Authenticate as Default Context Seller User","id":"388ec417-8900-4034-9733-b29f5dd29a18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"client_id=53181F89-0251-4483-90A8-178379A11FBD&grant_type=client_credentials&client_secret=super-secret-and-secure-client-secret-key&scope=FullAccess"},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"388ec417-8900-4034-9733-b29f5dd29a18"}],"id":"2368da27-99ae-4e26-b674-b78845f26b5b","description":"Create a new API Client that your integration would authenticate against in order to make requests.
\n","event":[{"listen":"prerequest","script":{"id":"cb24c200-bb28-4bc6-bd57-421c8ef3ef09","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e576dc1f-7175-4ba4-884f-d4f5df053b2f","type":"text/javascript","exec":[""]}}],"_postman_id":"2368da27-99ae-4e26-b674-b78845f26b5b"},{"name":"Configure Anonymous Shopping","item":[{"name":"Put Buyer API Client with \"isAnonBuyer\": true","id":"057ab083-aaa1-4c31-8a79-2195d15c2350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{admin_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"746DEC92-6811-492D-9467-30F2F5F31CB9\",\r\n \"ClientSecret\": null,\r\n \"AccessTokenDuration\": 500,\r\n \"Active\": true,\r\n \"AppName\": \"Buyer App\",\r\n \"RefreshTokenDuration\": 0,\r\n \"DefaultContextUserName\": \"bill\",\r\n \"xp\": null,\r\n \"AllowAnyBuyer\": true,\r\n \"AllowAnySupplier\": false,\r\n \"AllowSeller\": false,\r\n \"IsAnonBuyer\": true,\r\n \"AssignedBuyerCount\": 0,\r\n \"AssignedSupplierCount\": 0\r\n}"},"url":"{{baseApiUrl}}/v1/apiclients/{{clientID_buyer}}","urlObject":{"path":["v1","apiclients","{{clientID_buyer}}"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"057ab083-aaa1-4c31-8a79-2195d15c2350"},{"name":"Authenticate as Anonymous User (bill)","id":"88c8c973-d56d-4ec9-8f92-bf6851e9ea65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"client_id={{clientID_buyer}}&scope=ProductReader CategoryReader MeAddressAdmin MeCreditCardAdmin Shopper&grant_type=client_credentials"},"url":"{{baseApiUrl}}/oauth/token","urlObject":{"path":["oauth","token"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"88c8c973-d56d-4ec9-8f92-bf6851e9ea65"},{"name":"Get Products as Anon Shopper","id":"dff8a9bd-8cb7-4adf-93ea-0a6b8cd47356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{anon_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseApiUrl}}/v1/me/products","urlObject":{"path":["v1","me","products"],"host":["{{baseApiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dff8a9bd-8cb7-4adf-93ea-0a6b8cd47356"}],"id":"b90ddebc-967f-4c7c-a3af-f65b38de4e0c","description":"Anonymous Shopping, or Guest Checkout, is when a user is enabled to browse a catalog of products and/or checkout without registering themselves. Read more here.
\nConfigure your API Client so that the DefaultContextUserName is the default buyer user you want the anonymous people to shop as. Set IsAnonBuyer. When authenticating with the Client Credential Grant Type flow. you should get that default buyer user that you assigned.
\n","event":[{"listen":"prerequest","script":{"id":"c556d439-6d38-4723-91b5-cbaee458787f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79f4966f-303a-404d-b28e-6228e02a53e0","type":"text/javascript","exec":[""]}}],"_postman_id":"b90ddebc-967f-4c7c-a3af-f65b38de4e0c"}],"id":"8503eaac-2725-4cb0-bc01-9e9fc7d9ab82","description":"Impersonation is a tool that is often used in B2B scenarios for a CSR/Customer Service Rep type position. A user calls in, and the CSR takes an order on behalf of a customer on the phone. Let's dig into impersonation a little bit through these next few requests.
\n","event":[{"listen":"prerequest","script":{"id":"26e156f5-ff4e-43f5-babc-5bac902b1741","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d32be41b-9936-4fae-a260-63a0686733be","type":"text/javascript","exec":[""]}}],"_postman_id":"8503eaac-2725-4cb0-bc01-9e9fc7d9ab82"}],"event":[{"listen":"prerequest","script":{"id":"bc3c3cf7-cc1d-49db-a66c-c2aef07fb984","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"924442af-9a52-4ef8-8c07-b8c48afc1ae1","type":"text/javascript","exec":[""]}}],"variable":[{"id":"b1a783c3-1fda-4746-8587-e50928192773","key":"clientID_seller","value":"53181F89-0251-4483-90A8-178379A11FBD","type":"string"},{"id":"2af80581-3c4f-4af7-932d-7d2c1529bfbd","key":"admin_username","value":"steinmetzadmin","type":"string"},{"id":"e53fb14d-033f-4280-8052-a0eeaab58940","key":"admin_password","value":"fails345","type":"string"}]}