Back to Zoey Support
\nBack to Zoey Homepage
Zoey's REST API OAuth 2.0 protocol to authenticate the application to access the Zoey service.
\n","_postman_id":"b354e77f-6dec-4441-90fe-88e295faaaa4","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","name":"Overview","type":"folder"}}},{"name":"Output Formats","item":[],"id":"9272105d-a260-43f0-bcbd-c3b8aa5f82c8","description":"The REST API supports the response in two formats, which are XML and JSON.
\n","_postman_id":"9272105d-a260-43f0-bcbd-c3b8aa5f82c8","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","name":"Overview","type":"folder"}}},{"name":"HTTP Verbs","item":[],"id":"bb9e8699-5406-4db3-aa1d-3d44daeec172","description":"HTTP verbs are used to manage the state of resources. In Zoey's REST API, there are four verbs used to manage resources: GET, POST, PUT, and DELETE. You can get the contents of the data using HTTP GET, delete the data using HTTP DELETE, and create or update the data using POST/PUT.
\n","_postman_id":"bb9e8699-5406-4db3-aa1d-3d44daeec172","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","name":"Overview","type":"folder"}}},{"name":"Request Structure","item":[],"id":"b407711b-3307-403f-9efc-6867e2e98b41","description":"All URLs in REST API have the following base URL.
\nhttps://[zoeysite]/api/rest/
\nExample\nSupposing, you want to retrieve the list of customers from Zoey. To do this, you need to use the GET HTTP method. The GET request to retrieve the list of customers will look as follows:
\nhttps://[zoeysite]/api/rest/customers
\nwhere
\nThe Zoey REST API allows you to manage customers, customer addresses, sales orders, inventory, and products.
\n","_postman_id":"b407711b-3307-403f-9efc-6867e2e98b41","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","name":"Overview","type":"folder"}}},{"name":"Additional Information","item":[],"id":"e46f301b-f04f-4603-9310-ecbd0342559a","description":"You can define the limit of items returned in the response by passing the limit parameter. By default, 10 items are returned and the maximum number is 100 items. You can also define the page number by passing the page parameter. Example:
\nhttps://tsxxxx-container.zoeysite.com/api/rest/products?page=2&limit=20
\nAuthorization header will be required for Admin and Customer user types. The following parameters must be provided in the Authorization header for the call:
\nFor sales entities like \"Quotes\", \"Cart\", and \"Orders\":
\nAny value prefixed with base_ is based off of the store default value and is where calculations are made from. Each base_ key should also be coupled with a non base_ key which is used for customer display. For currencies this means that any conversion is done on the base_ key and stored to the non base_ key.
Example:
\n","event":[{"listen":"prerequest","script":{"id":"45d940d8-235c-4495-884c-661bc4a0d327","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"48ae9c0f-c495-465e-bdad-b178675e2bc3","type":"text/javascript","exec":[""]}}],"_postman_id":"c83f0ac7-e187-494e-b1c8-88c669523310","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","id":"b2ec02d8-4c02-47fe-a536-d4d98a10bbf3","name":"Overview","type":"folder"}}},{"name":"Errors","item":[],"id":"a54e5e72-e2ad-475a-b389-d1b39ce8da61","description":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": 401,\n \"message\": \"oauth_problem=token_rejected\"\n }\n ]\n }\n}\n\nWhat is REST API? To make it simple, REST API defines a set of functions to which the developers can perform requests and receive responses. The interaction is performed via the HTTP protocol. An advantage of such an approach is the wide usage of HTTP. That is why REST API can be used practically for any programming language.
\nCommon characteristics of the Zoey REST API resources are as follows: ([zoeysite] is your domain)
\nAt the time a Client is created, it will be provided a client_id and a client_secret which can be used depending on the type of Grant Types allowed to this Client.
At anytime, a Client can be disabled. Once a Client is disabled it will no longer allow any authentication, or any access to previously granted access tokens.
\nAt the top of the Client View there will be a button to \"Revoke All Tokens\". This will delete any access and refresh tokens that have been generated to be used by this client. Any integration that is using these access tokens will be forced to re authenticate.
\n\n\n","_postman_id":"c1d4be2d-3329-476d-89e5-101b353eac97","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"58a099f5-49a0-4478-81fa-7596075547c3","id":"58a099f5-49a0-4478-81fa-7596075547c3","name":"oAuth 2.0","type":"folder"}}},{"name":"Grant Types","item":[{"name":"Authorization Code","item":[],"id":"4223eff2-828b-4e3c-8cf5-9fbbfa3ded65","description":"Note:
\n
Because the API KEY Grant Type does not use Access Tokens the only way to prevent it from making requests would be to disable the client.
Use this Grant Type when the API integration requires it to call data on behalf of a user. When using this Grant Type, the user will be required to authenticate before an authorization code can be provided. Once the authorization code is provided, it can be exchanged for an access token and used to fetch data.
\nFor extra security Zoey has built in support for PKCE. It is encouraged to use PKCE when using the Authroization Grant Type. If for some reason the platform you are using does not support it, you are able to disable.
\n\n\nNote:
\n
As of right now Zoey only supports theS256challenge method and will reject theplain
challenge method if attempted to be used.
During the initial authorization a check will be made that the redirect_uri where the authorization code is being sent to is a valid URI. We do this by allowing you to set the Allowed Redirect URI's so that a more secure validation can take place.
To Use:
\nCreate a Client that allows for the Authorization Code Grant Type. Make sure it is enabled. (Optionally it is encouraged that you enable the With PKCE setting for increased security).
\nYou need to then obtain an Authorization Code for the User you want to authenticate. This is done by redirecting the user to your stores \"Authorization URL\". This can be a standard GET request in a browser to https://{{ YOUR STORE CODE HERE}}/admin/oauth_authorize. This URL must contain query parameters for:
• response_type=code
• client_id={{ YOUR CLIENT ID }}
• redirect_uri={{ URL WHERE YOU WANT THE CODE TO BE SENT }} ( note this must be allowed in the client settings)
Optionally for PKCE:
• code_challenge={{ a RANDOM base64 encoded hashed value }} ( Save the un-hashed value as it will be needed as the code_verifier when obtaining the Access Token. )
• code_challenge_method=S256 ( note that right now Zoey only supports sha-256 hashing for the code challenge. Plain is not supported. )
The User then will then be given the opportunity to either \"Authorize\" or \"Reject\" this request.
\n4. If the User \"Authorizes\". A GET request will be sent back to the redirect_uri specified with the code as a query parameter.
https://{{ YOUR REQUEST URI HERE }}?code=6aa7726b3db5e6c6fe53fa3f280d205c\n\n5. Next you need to obtain a new Access Token using the recently obtained Authorization Code. To get this Access Token you need to make a request to your \"Token URL\".
\ncurl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=authorization_code\" \\\n -d \"code={{ YOUR_AUTHORIZATION_CODE }}\" \\\n -d \"redirect_uri={{ REDIRECT URI USED DURING AUTHORIZATION }}\" \\\n -d \"client_id={{ YOUR_CLIENT_ID }}\" \\\n -d \"client_secret={{ YOUR_CLIENT_SECRET }}\"\n\n\n\nNote:
\n
Theclient_idandclient_secretcan either be sent in the request body OR in the Authorization Header.
curl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -H \"Authorization: Basic $(echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64)\" \\\n -d \"grant_type=authorization_code\" \\ \n -d \"code={{ YOUR_AUTHORIZATION_CODE }}\" \\\n -d \"redirect_uri={{ REDIRECT URI USED DURING AUTHORIZATION }}\"\n\nIF using PKCE and a code_challenge was used during authoriztion. A code_verifier will be required when obtaining the Access Token. The code_verifier is the \"un hashed\" value of the code_challenge that was used when obtaining the authorization code. This code_verifier is a 1 time value and should be random.
curl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -H \"Authorization: Basic $(echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64)\" \\\n -d \"grant_type=authorization_code\" \\ \n -d \"code={{ YOUR_AUTHORIZATION_CODE }}\" \\\n -d \"redirect_uri={{ REDIRECT URI USED DURING AUTHORIZATION }}\" \\\n -d \"code_verifier={{ CODE VERIFIER }}\"\n\nThe response will contain information about your Access Token and optionally a Refresh Token ( Only if that Grant Type is allowed by this Client).
\n{\"token_type\":\"bearer\",\"expires_in\":3600,\"created_at\":1740141611,\"access_token\":\"cf99a935ca10523b251913b51c973f5f\",\"refresh_token\":\"92126beafee10ee56d2ae8980a3d9f04\"}\n\nOnce you have the Access Token you are able to make requests using it in the Authorization Header.
\ncurl https://{{ YOUR STORE CODE HERE }}/api/rest/products/ -H 'Authorization: Bearer cf99a935ca10523b251913b51c973f5f'\n\nUse this Grant Type in conjunction with the Authroization Code Grant Type to allow the API integration to easily obtain new access tokens as they expire.
\nTo Use:
\nCreate a Client that allows for the Refresh Token Grant Type. Make sure it is enabled.
\nNext you need to obtain a new Access Token using the previously obtained Refresh Token. To get this Access Token you need to make a request to your \"Token URL\".
\ncurl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=refresh_token\" \\\n -d \"refresh_token=YOUR_REFRESH_TOKEN\" \\\n -d \"client_id=YOUR_CLIENT_ID\" \\\n -d \"client_secret=YOUR_CLIENT_SECRET\"\n\n\n\nNote:
\n
Theclient_idandclient_secretcan either be sent in the request body OR in the Authorization Header.
curl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -H \"Authorization: Basic $(echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64)\" \\\n -d \"grant_type=client_credentials\" \\ \n -d \"refresh_token=YOUR_REFRESH_TOKEN\"\n\nThe response will contain information about your Access Token and your new Refresh Token.
\n{\"token_type\":\"bearer\",\"expires_in\":3600,\"created_at\":1740141611,\"access_token\":\"cf99a935ca10523b251913b51c973f5f\",\"refresh_token\":\"92126beafee10ee56d2ae8980a3d9f04\"}\n\nOnce you have the Access Token you are able to make requests using it in the Authorization Header.
\ncurl https://{{ YOUR STORE CODE HERE }}/api/rest/products/ -H 'Authorization: Bearer cf99a935ca10523b251913b51c973f5f'\n\nThis Grant Type does NOT require any user authentication. It can obtain an access token at any time and use it as needed.
\nTo Use:
\nCreate a Client that allows for the Client Credentials Grant Type. Make sure it is enabled.
\nNext you need to obtain an Access Token before you can start fetching data. To get this Access Token you need to make a request to your \"Token URL\".
\ncurl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=client_credentials\" \\\n -d \"client_id=YOUR_CLIENT_ID\" \\\n -d \"client_secret=YOUR_CLIENT_SECRET\"\n\n\n\nNote:
\n
Theclient_idandclient_secretcan either be sent in the request body OR in the Authorization Header.
curl -X POST \"https://{{ YOUR STORE CODE HERE }}/oauth/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -H \"Authorization: Basic $(echo -n 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET' | base64)\" \\\n -d \"grant_type=client_credentials\"\n\nThe response will contain information about your Access Token.
\n{\"token_type\":\"bearer\",\"expires_in\":3600,\"created_at\":1740141611,\"access_token\":\"cf99a935ca10523b251913b51c973f5f\"}\n\nOnce you have the Access Token you are able to make requests using it in the Authorization Header.
\ncurl https://{{ YOUR STORE CODE HERE }}/api/rest/products/ -H 'Authorization: Bearer cf99a935ca10523b251913b51c973f5f'\n\nThe API KEY Grant Type will bypass all authorization and can be used directly to fetch data. Unlike the other Grant Types this key will never expire and never needs to be refreshed. Because of that its very important that this value is kept safe.
\nTo Use:
\nCreate a Client that allows for the Api Key Grant Type. Make sure it is enabled.
\nStart Using the API Key. The value of the Api-Key header will be the client_secret that was generated when the Client was created.
curl https://{{ YOUR STORE CODE HERE }}/api/rest/products/ -H 'Api-Key: 95b1374d58c764e3aaae085b3dfce75a9c2104cbc2ab7977346f4ec121f94174'\n\nZoey provides workflows for a few different Grant Types which can be used according to the needs of the API integration.
\nZoey now has support for oAuth 2.0 Authentication. To get started using oAuth 2.0 first navigate to Settings > AP > REST - oAuth 2.0 Clients to create your first oAuth 2.0 Client.
\n\n\nGet Help Setting Up Postman by using our Easy To Follow Postman Setup Guide
\n
When adding a new client you will see a Client ID and a Client Secret. These values should be kept safe and not exposed at any time.
\nZoey Follows the oAuth 2.0 Standard
Learn More about oAuth 2.0 here
Get one quote comment by id.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Quote comment id. (Required)
\n","type":"text/plain"},"key":"id","value":"52"}],"variable":[]}},"response":[],"_postman_id":"97f78c62-a730-4455-85e1-df1cf440a555"},{"name":"Add","id":"9b4fe87b-fa57-43c8-8cb0-328cc8ba9cf9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"109\",\n \"commentData\": {\n \"comment\": \"A Comment\",\n \"is_private_comment\": true,\n \"send_email\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://container-url.zoeysite.com/api/rest/quotes2/quote_comment/","description":"Add a new comment to a quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Add a new comment to a quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Quote ID. (Required)
\n","type":"text/plain"},"key":"id","value":"113"}],"variable":[]}},"response":[],"_postman_id":"9564220f-635e-4e41-831c-40ba02f8c028"}],"id":"25eadaf5-3c28-4180-b7bb-269745d1c9f8","_postman_id":"25eadaf5-3c28-4180-b7bb-269745d1c9f8","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"ID of quote to fetch info for. ( Required )
\n","type":"text/plain"},"key":"quoteId","value":"113"}],"variable":[]}},"response":[{"id":"c3b2612b-ff22-466b-b988-8c10d11afec8","name":"Get Offline","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://container-url.zoeysite.com/api/rest/quotes2/quote_shipping_offline?quoteId=113","host":["https://container-url.zoeysite.com/api/rest"],"path":["quotes2","quote_shipping_offline"],"query":[{"key":"quoteId","value":"113","description":"ID of quote to fetch info for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 25 Nov 2020 19:07:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"carrier\": \"flatrate\",\n \"carrier_title\": \"Flat Rate 1\",\n \"code\": \"flatrate_flatrate\",\n \"method\": \"flatrate\",\n \"method_description\": \"\",\n \"price\": \"5.00\",\n \"error_message\": \"This shipping method is currently unavailable. If you would like to ship using this shipping method, please contact us.\",\n \"method_title\": \"Standard Shipping\",\n \"carrier_type\": \"\",\n \"custom_description\": \"\",\n \"carrier_id\": \"\",\n \"tooltip\": \"\",\n \"customs_message\": \"\",\n \"carrierName\": \"Standard Shipping\",\n \"handling_fee\": \"\",\n \"handling_type\": \"F\",\n \"type\": \"O\"\n },\n {\n \"code\": \"b2bquotes_custom_shipping\",\n \"carrier_title\": \"\",\n \"method_title\": \"Custom Shipping\",\n \"custom_description\": null,\n \"price\": null,\n \"price_number\": null\n }\n]"}],"_postman_id":"950c45d7-ddc8-46f6-a134-26064bcf427d"},{"name":"Get","id":"5a75685d-d8d7-4848-a99a-c8aed3b67376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://container-url.zoeysite.com/api/rest/quotes2/quote_shipping?quoteId=113","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"ID of quote to fetch info for. ( Required )
\n","type":"text/plain"},"key":"quoteId","value":"113"}],"variable":[]}},"response":[{"id":"34233f93-fb17-49e0-8f54-f9f1d0689d7c","name":"Get","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://container-url.zoeysite.com/api/rest/quotes2/quote_shipping?quoteId=113","host":["https://container-url.zoeysite.com/api/rest"],"path":["quotes2","quote_shipping"],"query":[{"key":"quoteId","value":"113","description":"ID of quote to fetch info for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 25 Nov 2020 19:10:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=51np6c0pljp2cu4rvrpu6hm4t5; expires=Sat, 28-Nov-2020 19:10:11 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"Set-Cookie","value":"customer_group=0; expires=Sat, 28-Nov-2020 19:10:11 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"carrier\": \"shipper\",\n \"carrier_title\": \"Shipping Rates\",\n \"code\": \"shipper_error\",\n \"method\": null,\n \"method_description\": null,\n \"price\": \"0.0000\",\n \"error_message\": \"This shipping method is currently unavailable. If you would like to ship using this\\n shipping method, please contact us.\\n \",\n \"method_title\": null,\n \"freight_rate\": \"0\",\n \"pickup_location\": null,\n \"time_slot\": null,\n \"pickup_latitude\": null,\n \"pickup_longitude\": null,\n \"pickup_email\": null,\n \"pickup_contact\": null,\n \"pickup_email_option\": null,\n \"carrier_type\": null,\n \"dispatch_date\": null,\n \"delivery_date\": null,\n \"carrier_notice\": null,\n \"custom_description\": null,\n \"carrier_id\": null,\n \"custom_duties\": null,\n \"carriergroup_id\": null,\n \"carriergroup\": null,\n \"carriergroup_shipping_details\": null,\n \"tooltip\": null,\n \"customs_message\": null,\n \"carrierName\": \"Shipping Rates\"\n },\n {\n \"carrier\": \"freeshipping\",\n \"carrier_title\": \"Free Shipping\",\n \"code\": \"freeshipping_freeshipping\",\n \"method\": \"freeshipping\",\n \"method_description\": null,\n \"price\": \"0.0000\",\n \"error_message\": null,\n \"method_title\": \"Free\",\n \"freight_rate\": \"0\",\n \"pickup_location\": null,\n \"time_slot\": null,\n \"pickup_latitude\": null,\n \"pickup_longitude\": null,\n \"pickup_email\": null,\n \"pickup_contact\": null,\n \"pickup_email_option\": null,\n \"carrier_type\": null,\n \"dispatch_date\": null,\n \"delivery_date\": null,\n \"carrier_notice\": null,\n \"custom_description\": null,\n \"carrier_id\": null,\n \"custom_duties\": null,\n \"carriergroup_id\": null,\n \"carriergroup\": null,\n \"carriergroup_shipping_details\": null,\n \"tooltip\": null,\n \"customs_message\": null,\n \"carrierName\": \"Free Shipping\"\n },\n {\n \"carrier\": \"flatrate\",\n \"carrier_title\": \"Flat Rate 1\",\n \"code\": \"flatrate_flatrate\",\n \"method\": \"flatrate\",\n \"method_description\": null,\n \"price\": \"5.0000\",\n \"error_message\": null,\n \"method_title\": \"Standard Shipping\",\n \"freight_rate\": \"0\",\n \"pickup_location\": null,\n \"time_slot\": null,\n \"pickup_latitude\": null,\n \"pickup_longitude\": null,\n \"pickup_email\": null,\n \"pickup_contact\": null,\n \"pickup_email_option\": null,\n \"carrier_type\": null,\n \"dispatch_date\": null,\n \"delivery_date\": null,\n \"carrier_notice\": null,\n \"custom_description\": null,\n \"carrier_id\": null,\n \"custom_duties\": null,\n \"carriergroup_id\": null,\n \"carriergroup\": null,\n \"carriergroup_shipping_details\": null,\n \"tooltip\": null,\n \"customs_message\": null,\n \"carrierName\": \"Flat Rate 1\"\n }\n]"}],"_postman_id":"5a75685d-d8d7-4848-a99a-c8aed3b67376"}],"id":"85f0cb7f-378d-4634-9cd3-1b50dddd8a9e","_postman_id":"85f0cb7f-378d-4634-9cd3-1b50dddd8a9e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Add new products to the quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Get all products from the quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Quote ID.
\n","type":"text/plain"},"key":"id","value":"4"}],"variable":[]}},"response":[{"id":"ebc425d2-6325-4d81-bda1-282dfd41612c","name":"Add Product","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"113\",\n \"products\": [\n {\n \"product_id\": \"118\",\n \"qty\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://container-url.zoeysite.com/api/rest/quotes2/quote_product/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 25 Nov 2020 18:45:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=51np6c0pljp2cu4rvrpu6hm4t5; expires=Sat, 28-Nov-2020 18:45:41 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"Set-Cookie","value":"customer_group=0; expires=Sat, 28-Nov-2020 18:45:41 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"c62dda89-e28a-4f48-8efa-dd7a9760ed01"},{"name":"Update","id":"c48848fe-2af7-4d10-8aad-c1750cb8a8ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"quoteId\": \"4\",\n \"products\": [\n {\n \"product_id\": \"1\",\n \"qty\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://container-url.zoeysite.com/api/rest/quotes2/quote_product","description":"Update the products on the quote.
\nItem identifier is required. You can identify an item by either:
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Delete products from the quote.
\nItem identifier is required. You can identify an item by either:
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Each quote requires either a guest or existing customer.
\nText type attributes value must be a string.
\n"},{"key":"attributeData[custom_attribute_type_textarea]","value":"This is an example textarea value.","type":"text","description":"Textarea type attributes value must be a string.
\n"},{"key":"attributeData[custom_attribute_type_boolean]","value":"1","type":"text","description":"Boolean type attributes value must be a string 1 or 0
\n"},{"key":"attributeData[custom_attribute_type_multiselect]","value":"100,101","type":"text","description":"Multiselect type attributes value must be a comma separated string of option value ids. Ex: 100, 101, 102
\n"},{"key":"attributeData[custom_attribute_type_select]","value":"102","type":"text","description":"Select type attributes value must be an option value id.
\n"},{"key":"attributeData[custom_attribute_type_date]","value":"2022-01-01","type":"text","description":"Date type attributes value must be formatted like YYYY-MM-DD
\n"},{"key":"attributeData[custom_attribute_type_time]","value":"13:01","type":"text","description":"Time type attributes value must be formatted like HH:MM (24 hr format)
\n"},{"key":"attributeData[custom_attribute_type_datetime]","value":"2022-01-01T13:01","type":"text","description":"Datetime type attributes value must be formatted like YYYY-MM-DDTHH:MM (24 hr format for HH)
\n"},{"key":"attributeData[custom_attribute_type_file]","description":"File type attribute value will post the file. Must use valid \"form-data\" Content-Type Header to post files.
\n","type":"file","src":"/Users/dondesroches/Pictures/msrp.jpg"}]},"url":"https://container-url.zoeysite.com/api/rest/quotes2/quote_attributes","description":"Used to set values of custom quote attribute values.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"Quote ID. ( Required )
\n","type":"text/plain"},"key":"id","value":"113"}],"variable":[]}},"response":[{"id":"6d9d6b1b-6dee-4c53-9f7c-9e82e1965a45","name":"Get Totals","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://container-url.zoeysite.com/api/rest/quotes2/quote_totals?id=113","host":["https://container-url.zoeysite.com/api/rest"],"path":["quotes2","quote_totals"],"query":[{"key":"id","value":"113"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 25 Nov 2020 19:15:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"PHPSESSID=51np6c0pljp2cu4rvrpu6hm4t5; expires=Sat, 28-Nov-2020 19:15:27 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"Set-Cookie","value":"customer_group=0; expires=Sat, 28-Nov-2020 19:15:27 GMT; Max-Age=259200; path=/; domain=local.zoeysite.com; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"Subtotal\",\n \"amount\": 136.36\n },\n {\n \"title\": \"Discount\",\n \"amount\": 0\n },\n {\n \"title\": \"Gift Card\",\n \"amount\": 0\n },\n {\n \"title\": \"Shipping & Handling (Flat Rate 1 - Standard Shipping)\",\n \"amount\": \"5.0000\"\n },\n {\n \"title\": \"Tax\",\n \"amount\": \"13.6400\"\n },\n {\n \"title\": \"Grand Total\",\n \"amount\": 155\n }\n]"}],"_postman_id":"9aaabe65-1721-4387-a618-ab9edd916f67"}],"id":"356ecf10-c00a-4ba2-89d1-79464ad900bf","_postman_id":"356ecf10-c00a-4ba2-89d1-79464ad900bf","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"ID of quote. ( Required )
\n","type":"text"},{"key":"file_content","description":"File being uploaded as customer signature. (Required)
\n","type":"file","src":"customer_signature.png"},{"key":"file_mime_type","value":"image/png","description":"File mime_type of image file. Must match file_content mime_type. (Required)
\n","type":"text"}]},"url":"https://container-url.zoeysite.com/api/rest/quotes2/customer_signature","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientId","value":"client_id"},{"key":"refreshRequestParams","value":"