CartRover is now Extensiv Integration Manager
\nCartRover is a platform that effortlessly connects your sales channels (carts & marketplaces) with your back-end OMS or WMS system. Integrate with CartRover once and leverage our library of ecommerce integations. Learn More.
\nThe CartRover Orders API is a RESTful service that performs all data communication in JSON format. The order of the fields you submit is not important and the order of fields returned is not guaranteed.
\nThere are four different levels of API access: Cart, Merchant, Warehouse, Master. Each provides access to different endpoints listed in their sections below.
\nAll API levels have separate access credentials but use the same authorization procedure and data formats for sending and receiving.
\nTo monitor the API status and uptime, subscribe to our status page.
\nBase URL: https://api.cartrover.com
For general CartRover support and information view our knowledgebase where you can learn about CartRover and open support tickets.
\nWhen requesting API support please include your API User and the X-CartRover-Process-ID response header value for any specific requests you have made. We recommend you log this response header for every API request you make so that you have it for reference if you ever need to go back and ask about a specific call. Without this value we won't be able to help as much.
Check out the official sample CartRover PHP Client. Just include it directly in your project.
\nAdditional unofficial CartRover Libraries:
\nRuby Client - Cart level only
\nRemember to keep your keys secret and secure. You can cycle your API keys in CartRover when viewing them, which will immediately invalidate the previous keys.
\nPass your API User and Key using the Basic Access Authentication standard.
\nConcatenate the API user and key and place a colon in between: api_user:api_key
Base 64 encode this string
\nPass it as a header in the following format: Authorization: Basic BASE64ENCODEDSTRING
All endpoints will return errors in the following format.
\nThe CartRover API uses a Leaky Bucket algorithm to manage API access. The bucket size is 100 calls, and they refill at rate of 1 call every 0.6 seconds. Currently the New Order API endpoint is NOT rate limited. If we see abuse of the API, all endpoints will be rate limited.
\nAll endpoints that are rate limited will return the following header with each request. It contains the remaining number of API calls you can currently burst to:
\n\n\nX-CartRover-Api-Minute-Hits-Remaining
\n
If you go over your rate limit, the API will return a standard error with the following code and message:
\n{\n \"success_code\": false,\n \"error_code\": \"RateLimit\",\n \"message\": \"Over API Limit. Please slow down requests.\"\n}\n\nTimestamp fields should be submitted to the API in ISO 8601 format in order to specify the timezone.
\nTimestamp fields returned by the API will be formatted in ISO 8601 and always be in the UTC timezone.
\n\n\n2018-08-27T02:24:58+00:00
\n
If you are passing a timestamp as a GET parameter, YOU MUST percent encode the plus symbol (+) as % 2 B (without spaces)
The definitions below are how CartRover uses and calculates price fields. If you do not follow this standard, CartRover cannot guarantee the price information the warehouse receives will be correct.
\nsub_total: Sum of Order Line extended_amount fields.
\nDoes not include sales_tax, order_discount, or shipping_handling
\nIf loading orders, you may need to add the order_discount to the sub_total if the cart has one and doesn't include it in the sub_total.
\norder_discount: Total post-tax discount on order as a positive number.
\nsales_tax: Total tax on order
\nshipping_handling: Total shipping charge for the order passed from cart. No relation to the order line shipping_surcharge field.
\ngrand_total: sub_total + sales_tax + shipping_handling - order_discount
\nbalance: Not used right now. Set to 0 or leave off completely.
\nquantity: Number/Quantity of this product ordered.
\nprice: Cost of a single item. Does not include taxes, discounts, or shipping charges.
\ndiscount: Pre-tax Discount amounts to be applied to EACH single item as a positive number.
\naddl_discount: Post-tax Discount amount to be applied to the total item line as a positive number.
\ntax: Taxes applied to the total quantity of the total items in this line.
\nshipping_surcharge: Extra shipping charges that were added because of the total items in this line.
\nextended_amount: (price - discount) * quantity
\nReturns the order with the specified CUST_REF, which is guaranteed to be unique for all orders for a merchant.
\nThe format of the order returned will match the format of an order passed to the New Order API Endpoint.
\nIt will also have a shipments element containing an array of tracking information matching the shipments format from the View Order Status Endpoint.
\nAny filters should be passed with the URL as GET arguments
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","cart","orders","{{CUST_REF}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5391570d-0585-4658-a7d5-1280909bd93f","name":"View Order","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/orders/{{CUST_REF}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"created_date_time\": \"2019-05-23T23:49:28+00:00\",\n \"updated_date_time\": \"2019-05-24T19:20:06+00:00\",\n \"record_no\": null,\n \"version\": null,\n \"format\": null,\n \"cust_ref\": \"TEST07Auto\",\n \"cust_po_no\": \"TEST07Auto\",\n \"po_number\": null,\n \"carrier\": null,\n \"ship_code\": \"\",\n \"ship_code_description\": null,\n \"working_ship_code\": null,\n \"cust_company\": \"Will Town\",\n \"cust_title\": null,\n \"cust_first_name\": null,\n \"cust_last_name\": null,\n \"cust_address_1\": \"351 Hatchback Way\",\n \"cust_address_2\": \"Suite B140\",\n \"cust_address_3\": null,\n \"cust_city\": \"Santa Lucia\",\n \"cust_state\": \"NV\",\n \"cust_zip\": \"93707\",\n \"cust_country\": \"USA\",\n \"cust_phone\": null,\n \"cust_e_mail\": null,\n \"ship_company\": \"Will Town\",\n \"ship_title\": null,\n \"ship_first_name\": null,\n \"ship_last_name\": null,\n \"ship_address_1\": \"351 HITCHCOCK WAY STE B140\",\n \"ship_address_2\": null,\n \"ship_address_3\": null,\n \"ship_city\": \"SANTA BARBARA\",\n \"ship_state\": \"CA\",\n \"ship_zip\": \"93105-4016\",\n \"ship_country\": \"USA\",\n \"ship_phone\": null,\n \"ship_e_mail\": null,\n \"ship_address_type\": null,\n \"special_services\": null,\n \"customer_id\": null,\n \"order_date\": \"2019-05-23\",\n \"sub_total\": \"0.00\",\n \"order_discount\": \"0.00\",\n \"sales_tax\": \"0.00\",\n \"shipping_handling\": \"0.00\",\n \"grand_total\": \"0.00\",\n \"balance\": \"0.00\",\n \"currency_code\": null,\n \"credit_card_no\": null,\n \"expiration_date\": null,\n \"pay_type\": \"CA\",\n \"tax_exempt_sw\": null,\n \"installment_program\": null,\n \"media_week\": null,\n \"order_source\": \"APIAccess1\",\n \"promo_code\": null,\n \"ani_phone\": null,\n \"vendor_phone\": null,\n \"check_account_no\": null,\n \"check_type\": null,\n \"check_no\": null,\n \"check_bank_id\": null,\n \"check_cust_bank\": null,\n \"check_cust_id_num\": null,\n \"check_cust_id_state\": null,\n \"check_cust_id_mm\": null,\n \"check_cust_id_dd\": null,\n \"check_cust_id_yy\": null,\n \"check_cust_id_type\": null,\n \"location\": null,\n \"shipping_instructions\": null,\n \"ship_account_no\": null,\n \"ship_account_zip\": null,\n \"pre_auth_code\": null,\n \"pre_auth_amt\": \"0.00\",\n \"pre_auth_id\": null,\n \"cvv\": null,\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"custom_field_4\": null,\n \"custom_field_5\": null,\n \"gift_card_sw\": null,\n \"token_sw\": null,\n \"cass_code_ship\": \"V\",\n \"cass_error_ship\": null,\n \"cass_code_cust\": \"N\",\n \"cass_error_cust\": null,\n \"cass_date\": null,\n \"ncoa_code_ship\": null,\n \"ncoa_code_cust\": null,\n \"ncoa_date\": null,\n \"error_code\": null,\n \"error_msg\": null,\n \"ifraud_error_code\": null,\n \"xfraud_error_code\": null,\n \"credit_error_code\": null,\n \"resubmit_date\": null,\n \"black_list\": null,\n \"credit_score\": null,\n \"fraud_score\": null,\n \"load_override_sw\": null,\n \"fail_action\": null,\n \"action_dt\": null,\n \"filename\": null,\n \"call_queue\": null,\n \"clerk_disposition\": null,\n \"clerk_disp_dt\": null,\n \"rep_disposition\": null,\n \"rep_disp_dt\": null,\n \"duplicate_sw\": null,\n \"weight\": null,\n \"org_file_no\": null,\n \"gift_message\": null,\n \"gift_wrap\": null,\n \"delete_date\": null,\n \"routing_sw\": \"N\",\n \"sent_to_region\": null,\n \"accepted_by_region\": null,\n \"regional_center\": null,\n \"regional_order_no\": null,\n \"regional_ship_date\": null,\n \"regional_retry_sw\": \"N\",\n \"regional_error\": null,\n \"regional_attempts\": \"0\",\n \"first_attempt\": null,\n \"cancel_date\": null,\n \"changed_by\": \"Shopping Cart: cartrover\",\n \"changed_from_server\": \"william-pc\",\n \"changed_by_user\": \"williamw\",\n \"cc_last_four\": null,\n \"expected_delivery_date\": null,\n \"requested_ship_date\": null,\n \"latest_ship_date\": null,\n \"delivered_to_wms_date\": \"2019-05-24T19:20:06+00:00\",\n \"shipment_pk\": null,\n \"error_reason\": null,\n \"mark_in_progress_date\": null,\n \"extra_system_date_sent\": null,\n \"sending_canceled\": \"N\",\n \"shipping_pickup_canceled\": \"N\",\n \"on_hold\": \"N\",\n \"inventory_warehouse_pk\": \"1979\",\n \"items\": [\n {\n \"line_no\": \"1\",\n \"item\": \"C100\",\n \"lot_number\": null,\n \"quantity\": \"2\",\n \"price\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"addl_discount\": \"0.0000\",\n \"extended_amount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping_surcharge\": \"0.00\",\n \"line_item_id\": null,\n \"line_comment\": null,\n \"Description\": null,\n \"alt_sku\": null,\n \"filtered_sku\": \"N\",\n \"line_location\": \"\"\n },\n {\n \"line_no\": \"2\",\n \"item\": \"C300\",\n \"lot_number\": null,\n \"quantity\": \"1\",\n \"price\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"addl_discount\": \"0.0000\",\n \"extended_amount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping_surcharge\": \"0.00\",\n \"line_item_id\": null,\n \"line_comment\": null,\n \"Description\": null,\n \"alt_sku\": null,\n \"filtered_sku\": \"N\",\n \"line_location\": \"\"\n }\n ],\n \"shipments\": []\n }\n}"},{"id":"2b83f000-22f5-4bb9-bfb3-7c6eca90dea7","name":"View Invalid Order","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/orders/{{CUST_REF}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": false,\n \"error_code\": \"Invalid\",\n \"message\": \"Missing or invalid parameter: cust_ref - No such order found.\"\n}"}],"_postman_id":"524838f2-bbd4-4217-8bfe-44b51e37b600"},{"name":"View Order Status","id":"9e5b3003-3e57-48dc-8760-08ba2a01560c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{BASE_URL}}/v1/cart/orders/status/{{CUST_REF}}","description":"This will return the order status and tracking information for the specified CUST_REF.
\nCUST_REF is guaranteed to be unique for all orders for a merchant.
\nReturns all orders matching the given status for this cart.
\nPossible statuses: new, at_wms, shipped, confirmed, error, canceled, new_or_at_wms, shipped_or_confirmed, any
\nAny filters should be passed with the URL as GET arguments.
\nThe from_date and to_date fields perform a different search depending on the status you are searching. These are designed so you only have to search back though the time of your last successful API call in order to get all the new results.
\nNote: If you have a lot of orders and your API response time is slow, use narrower date ranges. For example, only search the past hour for shipments instead of the past day. Also consider the Order Update Webhook
\nThe response will contain an array of orders with the format/fields of each order matching the New Order endpoint POST data.
\nOrders may also contain shipment records (if the order is shipped). The shipments element of each order will match to the shipments element of the View Order Status endpoint response.
This endpoint expects a json object containing a single order with the fields listed below. The bolded headers are for reference and are not sub-objects. All fields are on the top level except for item information
\nYour warehouse may not pick up or use all of these fields. Any fields they do not use will be ignored.
\nAn array of items should be listed in the order's items field. Below are the fields allowed for each item.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","cart","orders","cartrover"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"d188bc23-9ba9-4694-92ea-302310e884ba","name":"Failure Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cust_ref\" : \"TEST02\",\n \"ship_company\" : \"Will Town\",\n \"ship_address_1\" : \"351 Hitchcock Way\",\n \"ship_address_2\" : \"Suite B140\",\n \"ship_city\" : \"Santa Barbara\",\n \"ship_state\" : \"CA\",\n \"ship_zip\" : \"93105\",\n \"ship_country\" : \"USA\",\n \"ship_is_billing\" : true,\n \"items\" : \n [\n {\n \"item\" : \"C100\",\n \"quantity\" : 2\n },\n {\n \"item\" : \"C300\",\n \"quantity\" : 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/orders/cartrover"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2019 20:21:38 GMT"},{"key":"Server","value":"Apache/2.2.34 (Amazon)"},{"key":"X-Powered-By","value":"PHP/7.1.30"},{"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":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"Content-Length","value":"128"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": false,\n \"cust_ref\": \"TEST02\",\n \"order_number\": \"TEST02\",\n \"error_code\": \"Failure\",\n \"message\": \"Duplicate cust_ref: TEST02\"\n}"},{"id":"b786b9af-b33e-4992-96e2-06b0a6e6d3ae","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cust_ref\" : \"TEST02\",\n \"ship_company\" : \"Will Town\",\n \"ship_address_1\" : \"351 Hitchcock Way\",\n \"ship_address_2\" : \"Suite B140\",\n \"ship_city\" : \"Santa Barbara\",\n \"ship_state\" : \"CA\",\n \"ship_zip\" : \"93105\",\n \"ship_country\" : \"USA\",\n \"ship_is_billing\" : true,\n \"sub_total\" : 14.00,\n \"order_discount\" : 2.00,\n \"tax\" : 1.00,\n \"grand_total\" : 15.00,\n \"extra_fields\" : {\n \"some_custom_field\" : \"some_value\",\n \"Another Field\" : \"Another Value\"\n },\n \"items\" : \n [\n {\n \"item\" : \"C100\",\n \"price\": 4.40,\n \"quantity\" : 2,\n \"extended_amount\": 9\n },\n {\n \"item\" : \"C300\",\n \"quantity\" : 1,\n \"price\": \"5.00\",\n \"extended_amount\": 5.00,\n \"extra_fields\" : {\n \"some_custom_field\" : \"some_value\",\n \"Another Field\" : \"Another Value\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/orders/cartrover"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success_code\": true,\r\n \"cust_ref\": \"TEST21\",\r\n \"order_number\": \"TEST21\"\r\n}"}],"_postman_id":"85fd6ea0-d996-49f2-9992-7262012c82ea"},{"name":"New Orders - Batch","id":"419e5cbb-0da2-4d1d-ac14-a4b76e9f6c4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"cust_ref\" : \"TEST02\",\n \"ship_company\" : \"Will Town\",\n \"ship_address_1\" : \"351 Hitchcock Way\",\n \"ship_address_2\" : \"Suite B140\",\n \"ship_city\" : \"Santa Barbara\",\n \"ship_state\" : \"CA\",\n \"ship_zip\" : \"93105\",\n \"ship_country\" : \"USA\",\n \"ship_is_billing\" : true,\n \"items\" : \n [\n {\n \"item\" : \"C100\",\n \"quantity\" : 2\n },\n {\n \"item\" : \"C300\",\n \"quantity\" : 1\n }\n ]\n },\n {\n \"cust_ref\" : \"TEST03\",\n \"ship_company\" : \"Will Town\",\n \"ship_address_1\" : \"351 Hitchcock Way\",\n \"ship_address_2\" : \"Suite B140\",\n \"ship_city\" : \"Santa Barbara\",\n \"ship_state\" : \"CA\",\n \"ship_zip\" : \"93105\",\n \"ship_country\" : \"USA\",\n \"ship_is_billing\" : true,\n \"items\" : \n [\n {\n \"item\" : \"C100\",\n \"quantity\" : 2\n },\n {\n \"item\" : \"C300\",\n \"quantity\" : 1\n }\n ]\n }\n]"},"url":"{{BASE_URL}}/v1/cart/orders/batch","description":"This endpoint expects a json array containing a batch of orders. Each order should have the same fields as those listed in the New Order endpoint. Please see that endpoint for individual order field names.
\nMax order batch size: 100
\nYour warehouse may not pick up or use all of these fields. Any fields they do not use will be ignored.
\nThe response element of the API response will contain two sub-elements, success and failed. Each of these elements will contain an array of results. Below is the list of all possible fields that may be set for each. See sample response for full details.
This will attempt to cancel the specified order in both CartRover and the WMS. The response will specify whether or not the order was able to be canceled.
\nNote: This call may take longer than others because CartRover will reach out to the WMS in real time and wait for a response.
\nUpdates the status of the order/shipments with the specified cust_ref.
\nReturns inventory levels for all products from the warehouse.\n
\nNote: Any filters should be passed with the URL as GET arguments.
This will return product and alias details for the specified product from the warehouse.
\nNote: The SKU you use to lookup the product can be either a Master SKU in CartRover, or an alias code. Either match will return the product result.
\nNote: Any filters should be passed with the URL as GET arguments.
\nThis will return inventory levels for the specified product from the warehouse.
\nThe qty_available inventory levels of each warehouse entry when added together may not match the summary qty_available field. This is because recent sales for each location cannot be subtracted from available quantity for a specific location if CartRover does not know how they will route. The summary inventory level will always be accurate.
\nReturns an array of acceptable warehouse ship methods. No parameters are required.\n
\nNote: This list is unlikely to change often, or ever at all. We recommend you cache/store this list and either update it occasionally or as needed on-demand
Note: The codes and descriptions returned are defined by the warehouse and not CartRover. They may differ from what you see here.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","wms","shipmethod","list"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"278bb0ec-3fcc-42bf-a8e1-be2432374dec","name":"List WMS Ship Methods","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/wms/shipmethod/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success_code\": true,\r\n \"response\": [\r\n {\r\n \"carrier\": \"USPS\",\r\n \"code\": \"01\",\r\n \"description\": \"USPS First Class Parcel\"\r\n },\r\n {\r\n \"carrier\": \"USPS\",\r\n \"code\": \"09\",\r\n \"description\": \"USPS Priority Mail\"\r\n },\r\n {\r\n \"carrier\": \"UPS\",\r\n \"code\": \"28\",\r\n \"description\": \"UPS Next Day Air\"\r\n },\r\n {\r\n \"carrier\": \"FEDEX\",\r\n \"code\": \"50\",\r\n \"description\": \"FedEx Ground\"\r\n },\r\n {\r\n \"carrier\": \"\",\r\n \"code\": \"DB\",\r\n \"description\": \"DHLGM Parcel Intl Standard\"\r\n }\r\n ]\r\n}"}],"_postman_id":"c43ecfdc-c22b-486a-827b-a3b8f342e02f"}],"id":"ae73e48e-bb7a-4954-9022-584b8fed3e0c","description":"Cart API calls are available to users with cart level credentials. These endpoints allow for common actions that a shopping cart or marketplace would want to implement.
\n","_postman_id":"ae73e48e-bb7a-4954-9022-584b8fed3e0c","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}}},{"name":"Merchant API","item":[{"name":"Filters","item":[{"name":"List Cart Item Filters","id":"f09a4aee-c40f-48d9-8a42-f9f61f087c85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/filters/item/list/{{ORDER_SOURCE}}","description":"Returns list of configured Item Filters for the given cart.
\nNote: Any filters should be passed with the URL as GET arguments.
\nNumber of products to return at once. Default 100, max 1000
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"Page of results to return. Default 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"3ea15b6d-a9cc-4bcf-abd0-d56c848dcb51","name":"List Cart Item Filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cartrover.com/v1/cart/filters/item/list/Shopify2?limit=20&page=1","protocol":"https","host":["api","cartrover","com"],"path":["v1","cart","filters","item","list","Shopify2"],"query":[{"key":"limit","value":"20","description":"Number of products to return at once. Default 100, max 1000"},{"key":"page","value":"1","description":"Page of results to return. Default 1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"items\": [\n \"1_2_A_B\",\n \"1234\",\n \"5423\",\n \"654365f\",\n \"sdfg\"\n ],\n \"rules\": {\n \"product_filter_type\": \"BLACKLIST\",\n \"product_filter_level\": \"ITEM\"\n },\n \"page\": 1,\n \"total_pages\": 1\n }\n}"}],"_postman_id":"f09a4aee-c40f-48d9-8a42-f9f61f087c85"},{"name":"Add Cart Item Filters","id":"b182486f-5065-4460-a496-a33e13980808","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"items\": [\n \"SKU_1\",\n \"SKU_2\"\n ],\n \"rules\": {\n \"product_filter_type\": \"BLACKLIST|WHITELIST|DISABLED\",\n \"product_filter_level\": \"ITEM|ORDER\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/filters/item/list/{{ORDER_SOURCE}}","description":"Add SKUs to Item Filter list for the given cart. Configure which rules apply to your Filter List.
\nDelete SKUs from the Item Filter list for the given cart.
\nReturns list of configured Order Filters for the given cart.
\nNote: Any filters should be passed with the URL as GET arguments.
\nEach filter object contains:
\ncust_po_no - Customer PO Number
po_number - PO Number
cust_company - Customer Company
cust_first_name - Customer First Name
cust_last_name - Customer Last Name
cust_city - Customer City
cust_state - Customer State
cust_zip - Customer ZIP
cust_country - Customer Country
cust_phone - Customer Phone
cust_e_mail - Customer Email
ship_company - Shipping Company
ship_first_name - Shipping First Name
ship_last_name - Shipping Last Name
ship_city - Shipping City
ship_state - Shipping State
ship_zip - Shipping ZIP
ship_country - Shipping Country
ship_phone - Shipping Phone
ship_e_mail - Shipping Email
ship_code - Shipping Code
carrier - Carrier
location - Location
Number of products to return at once. Default 100, max 1000
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"Page of results to return. Default 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"1f1f19c3-2afc-4ef8-ad97-b6cf2815a4dd","name":"List Cart Order Filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cartrover.com/v1/cart/filters/order/list/CommerceHub?limit=20&page=1","protocol":"https","host":["api","cartrover","com"],"path":["v1","cart","filters","order","list","CommerceHub"],"query":[{"key":"limit","value":"20"},{"key":"page","value":"1"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"84b4a79e-2fb4-46da-9c5f-d98ffbfb380c"},{"name":"Add Cart Order Filters","id":"360d315a-0974-43d6-b1ed-05ae029269d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"filters\": [\r\n {\r\n \"field\": \"cust_state\",\r\n \"value\": [\"CA\", \"NY\", \"TX\"],\r\n \"all_except_sw\": \"N\"\r\n },\r\n {\r\n \"field\": \"cust_country\", \r\n \"value\": [\"USA\", \"CAN\"],\r\n \"all_except_sw\": \"N\"\r\n },\r\n {\r\n \"field\": \"cust_company\", \r\n \"value\": [\"Cartrover\"],\r\n \"all_except_sw\": \"N\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/filters/order/list/{{ORDER_SOURCE}}","description":"Add Order Filters to Filter List for the given cart. Configure which rules apply to your Filter List.
\ncust_po_no - Customer PO Number
po_number - PO Number
cust_company - Customer Company
cust_first_name - Customer First Name
cust_last_name - Customer Last Name
cust_city - Customer City
cust_state - Customer State
cust_zip - Customer ZIP
cust_country - Customer Country
cust_phone - Customer Phone
cust_e_mail - Customer Email
ship_company - Shipping Company
ship_first_name - Shipping First Name
ship_last_name - Shipping Last Name
ship_city - Shipping City
ship_state - Shipping State
ship_zip - Shipping ZIP
ship_country - Shipping Country
ship_phone - Shipping Phone
ship_e_mail - Shipping Email
ship_code - Shipping Code
carrier - Carrier
location - Location
Update existing Order Filters in Filter List for the given cart. Modify filter rules and values for existing filters.
\ncust_po_no - Customer PO Number
po_number - PO Number
cust_company - Customer Company
cust_first_name - Customer First Name
cust_last_name - Customer Last Name
cust_city - Customer City
cust_state - Customer State
cust_zip - Customer ZIP
cust_country - Customer Country
cust_phone - Customer Phone
cust_e_mail - Customer Email
ship_company - Shipping Company
ship_first_name - Shipping First Name
ship_last_name - Shipping Last Name
ship_city - Shipping City
ship_state - Shipping State
ship_zip - Shipping ZIP
ship_country - Shipping Country
ship_phone - Shipping Phone
ship_e_mail - Shipping Email
ship_code - Shipping Code
carrier - Carrier
location - Location
Delete an existing Order Filter from Filter List for the given cart. Remove filter rules for a specific field.
\ncust_po_no - Customer PO Number
po_number - PO Number
cust_company - Customer Company
cust_first_name - Customer First Name
cust_last_name - Customer Last Name
cust_city - Customer City
cust_state - Customer State
cust_zip - Customer ZIP
cust_country - Customer Country
cust_phone - Customer Phone
cust_e_mail - Customer Email
ship_company - Shipping Company
ship_first_name - Shipping First Name
ship_last_name - Shipping Last Name
ship_city - Shipping City
ship_state - Shipping State
ship_zip - Shipping ZIP
ship_country - Shipping Country
ship_phone - Shipping Phone
ship_e_mail - Shipping Email
ship_code - Shipping Code
carrier - Carrier
location - Location
API endpoints controlling order and item filters
\nThe filter API endpoints are not yet live, but are coming very soon!
\n","_postman_id":"84e76d98-769a-45ae-a2a9-e42b3ab0d1ed","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}}},{"name":"List All Available Carts","id":"e9f7992e-4c7b-4764-9654-16595f1f0168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/listall","description":"This will return a list of all possible cart and order source connections that can be setup for this CartRover account, as well as the required and optional settings.
\nYou can optionally include a specific cart ID in the URL to return info for only that specific cart.
\nThis will return the single cart and order source connection connected to {{id}} that can be setup for this CartRover account, as well as the required and optional settings.
\nReturns a list of carts and order sources that have been setup for this merchant.
\nNote: Any filters should be passed with the URL as GET arguments.
\nReturns a list of all warehouses set up in CartRover. Any filters should be passed with the URL as GET arguments.
\nThe key for each warehouse in the array is the internal CartRover warehouyse id. This is needed for modifying the warehouse fields via the API.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","warehouse","list"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"9a832e23-25a4-40e1-860e-67b7c059f3e6","name":"List Warehouses","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"url":"https://api.cartrover.com/v1/merchant/warehouse/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"2305\": {\n \"inventory_warehouse\": \"Retail\",\n \"wms_warehouse_name\": \"Retail\",\n \"wms_warehouse_id\": null,\n \"extra_params\": null,\n \"disabled\": false,\n \"is_default\": true,\n \"restock_level\": null\n },\n \"2672\": {\n \"inventory_warehouse\": \"Wholesale\",\n \"wms_warehouse_name\": \"Wholesale\",\n \"wms_warehouse_id\": \"Wholesale\",\n \"extra_params\": {\n \"addresses\": [\n {\n \"AddressTypeCode\": \"ATC\",\n \"LocationCodeQualifier\": \"ACQ\",\n \"AddressLocationNumber\": \"ALN\",\n \"AddressName\": \"Some Warehouse\",\n \"Address1\": \"510 N. MILPAS ST.\",\n \"Address2\": \"\",\n \"City\": \"SANTA BARBARA\",\n \"State\": \"CA\",\n \"PostalCode\": \"93103\",\n \"Country\": \"United States\",\n \"Cart\": \"2078\"\n }\n ],\n \"contacts\": []\n },\n \"disabled\": false,\n \"is_default\": false,\n \"restock_level\": null\n }\n }\n}"}],"_postman_id":"ca5404b0-1c55-46bc-9d3e-b9c5afec2909"},{"name":"Create/Edit Warehouse","id":"ecfad051-6f30-4b63-b432-d20b12a7c40e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"inventory_warehouse\": \"New WHS\",\n \"wms_warehouse_name\": \"New WHS Name\",\n \"wms_warehouse_id\": \"New WHS ID\",\n \"default\": false\n}"},"url":"{{BASE_URL}}/v1/merchant/warehouse/{{WAREHOUSE_PK}}","description":"Creates or edits warehouses in CartRover. These are not different integrations, but different physical warehouses.
\nLeave off the {{WAREHOUSE_PK}} value to create a new warehouse.
\nPass the value to Edit the specified warehouse. Any fields left off the body will be unchanged.
\nIf successful, the warehouse will be returend in the same format as the List Warehouses API call.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","warehouse","{{WAREHOUSE_PK}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e603692c-038f-4cec-827c-ba1ca62d8ff7","name":"Edit Warehouse","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"inventory_warehouse\": \"Georgia Warehouse Name\",\r\n \"wms_warehouse_name\": \"Georgia\",\r\n \"wms_warehouse_id\": \"G132\",\r\n \"default\": true\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.cartrover.com/v1/merchant/warehouse/{{WAREHOUSE_PK}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"2305\": {\n \"inventory_warehouse\": \"Georgia Warehouse Name\",\n \"wms_warehouse_name\": \"Georgia\",\n \"wms_warehouse_id\": \"G132\",\n \"extra_params\": null,\n \"disabled\": false,\n \"is_default\": true,\n \"restock_level\": null\n }\n }\n}"}],"_postman_id":"ecfad051-6f30-4b63-b432-d20b12a7c40e"},{"name":"Edit Merchant","id":"c16e71b9-6e18-4da6-b28d-492bd45899d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test API Merch\",\r\n \"wms_params\": {\r\n \t\"ownerCode\": \"123\"\r\n }\r\n}"},"url":"{{BASE_URL}}/v1/merchant/edit","description":"Edit merchant info including name, wms parameters, and schedules. Any fields left off will be left as-is.
\nReturns all orders matching the given status for this cart.
\nPossible statuses: new, at_wms, shipped, confirmed, error, canceled, new_or_at_wms, shipped_or_confirmed, any
\nNew Orders: After downloading new orders, it is crucial you update the orders as at_wms for accurate inventory and to prevent loading orders multiple times. See: Update Order Status - At WMS
Notice: Due to performance implications, you are highly discouraged from using the new_or_at_wms on a regular basis for loading new orders. Please use the new status instead.
Any filters should be passed with the URL as GET arguments.
\nThe from_date and to_date fields perform a different search depending on the status you are searching. These are designed so you only have to search back though the time of your last successful API call in order to get all the new results.
\nNote: If you have a lot of orders and your API response time is slow, use narrower date ranges. For example, only search the past hour instead of the past day.
\nThe response will contain an array of orders with format/fields matching the New Orders endpoint.
\nOrders may also contain shipment records. Shipment records will match to the format of the View Order Status endpoint.
\nWhen reading item data, note that there may be multiple lines for the same SKU. If your system cannot handle this, you must check for this and summarize the item's total quantity when loading into your system. When posting back tracking data you may list the item in a single entry instead of breaking into two.
\nThe item field will contain the product code as provided by the order source. If you need this translated to another code, ensure you have Product Aliases setup in CartRover and pass the include_aliases field when requesting orders.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","orders","list","{{STATUS}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cbf13ef9-7634-4371-a70a-92274358b2a5","name":"List Merchant Orders By Status","originalRequest":{"method":"GET","header":[],"url":"https://api.cartrover.com/v1/merchant/orders/list/{{STATUS}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": [\n {\n \"created_date_time\": \"2016-07-14T19:07:16+00:00\",\n \"record_no\": \"156\",\n \"version\": null,\n \"format\": null,\n \"cust_ref\": \"156\",\n \"cust_ref_original\": null,\n \"cust_po_no\": \"156\",\n \"cust_po_no_original\": null,\n \"ship_code\": \"legacy_free_shipping\",\n \"ship_code_description\": \"Free Shipping\",\n \"working_ship_code\": null,\n \"cust_company\": null,\n \"cust_title\": null,\n \"cust_first_name\": \"Cart\",\n \"cust_last_name\": \"Test\",\n \"cust_address_1\": \"510 N. Milpas St\",\n \"cust_address_2\": \"\",\n \"cust_address_3\": null,\n \"cust_city\": \"Santa Barbara\",\n \"cust_state\": \"CA\",\n \"cust_zip\": \"93103\",\n \"cust_country\": \"USA\",\n \"cust_phone\": \"18053992278\",\n \"cust_e_mail\": \"help@cartrover.com\",\n \"ship_company\": \"CartRover\",\n \"ship_title\": null,\n \"ship_first_name\": \"William\",\n \"ship_last_name\": \"Wynn\",\n \"ship_address_1\": \"510 N. Milpas St.\",\n \"ship_address_2\": \"\",\n \"ship_address_3\": null,\n \"ship_city\": \"Santa Barbara\",\n \"ship_state\": \"CA\",\n \"ship_zip\": \"93103\",\n \"ship_country\": \"USA\",\n \"ship_phone\": \"18058982444\",\n \"ship_e_mail\": \"help@cartrover.com\",\n \"ship_address_type\": null,\n \"special_services\": null,\n \"customer_id\": \"4\",\n \"order_date\": \"2016-07-14\",\n \"sub_total\": \"0.00\",\n \"order_discount\": \"0.00\",\n \"sales_tax\": \"0.00\",\n \"shipping_handling\": \"0.00\",\n \"grand_total\": \"0.00\",\n \"balance\": \"0.00\",\n \"currency_code\": \"USD\",\n \"credit_card_no\": null,\n \"expiration_date\": null,\n \"pay_type\": \"CA\",\n \"tax_exempt_sw\": null,\n \"installment_program\": null,\n \"media_week\": null,\n \"order_source\": \"WooCommerce\",\n \"promo_code\": null,\n \"ani_phone\": null,\n \"vendor_phone\": null,\n \"check_account_no\": null,\n \"check_type\": null,\n \"check_no\": null,\n \"check_bank_id\": null,\n \"check_cust_bank\": null,\n \"check_cust_id_num\": null,\n \"check_cust_id_state\": null,\n \"check_cust_id_mm\": null,\n \"check_cust_id_dd\": null,\n \"check_cust_id_yy\": null,\n \"check_cust_id_type\": null,\n \"location\": null,\n \"shipping_instructions\": null,\n \"ship_account_no\": null,\n \"ship_account_zip\": null,\n \"pre_auth_code\": null,\n \"pre_auth_amt\": \"0.00\",\n \"pre_auth_id\": null,\n \"cvv\": null,\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"custom_field_4\": null,\n \"custom_field_5\": null,\n \"gift_card_sw\": null,\n \"token_sw\": null,\n \"cass_code_ship\": null,\n \"cass_error_ship\": null,\n \"cass_code_cust\": null,\n \"cass_error_cust\": null,\n \"cass_date\": null,\n \"ncoa_code_ship\": null,\n \"ncoa_code_cust\": null,\n \"ncoa_date\": null,\n \"error_code\": null,\n \"error_msg\": null,\n \"ifraud_error_code\": null,\n \"xfraud_error_code\": null,\n \"credit_error_code\": null,\n \"resubmit_date\": null,\n \"black_list\": null,\n \"credit_score\": null,\n \"fraud_score\": null,\n \"load_override_sw\": null,\n \"fail_action\": null,\n \"action_dt\": null,\n \"filename\": null,\n \"call_queue\": null,\n \"clerk_disposition\": null,\n \"clerk_disp_dt\": null,\n \"rep_disposition\": null,\n \"rep_disp_dt\": null,\n \"duplicate_sw\": null,\n \"weight\": null,\n \"org_file_no\": null,\n \"gift_message\": null,\n \"gift_wrap\": null,\n \"carrier\": null,\n \"delete_date\": null,\n \"routing_sw\": \"N\",\n \"sent_to_region\": null,\n \"accepted_by_region\": null,\n \"regional_center\": null,\n \"regional_order_no\": null,\n \"regional_ship_date\": null,\n \"regional_retry_sw\": \"N\",\n \"regional_error\": null,\n \"regional_attempts\": \"0\",\n \"first_attempt\": null,\n \"cancel_date\": null,\n \"cc_last_four\": null,\n \"expected_delivery_date\": null,\n \"requested_ship_date\": null,\n \"delivered_to_wms_date\": \"2017-05-12T21:10:04+00:00\",\n \"error_reason\": null,\n \"mark_in_progress_date\": \"2016-07-14T19:07:17+00:00\",\n \"extra_system_date_sent\": null,\n \"sending_canceled\": \"N\",\n \"shipping_pickup_canceled\": \"N\",\n \"on_hold\": \"N\",\n \"order_status\": \"shipped\",\n \"total_qty\": \"1\",\n \"num_to_ship\": \"-4\",\n \"num_shipped\": \"5\",\n \"items\": [\n {\n \"line_no\": \"1\",\n \"item\": \"CIOPEN\",\n \"lot_number\": null,\n \"quantity\": \"1\",\n \"price\": \"8.0000\",\n \"discount\": \"8.0000\",\n \"addl_discount\": \"0.0000\",\n \"extended_amount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping_surcharge\": \"0.00\",\n \"line_item_id\": null,\n \"line_comment\": null,\n \"Description\": \"CIO Pen - Test Product\",\n \"filtered_sku\": \"N\",\n \"line_location\": \"\"\n }\n ],\n \"shipments\": [\n {\n \"carrier\": \"FEDEX\",\n \"method\": \"50\",\n \"tracking_no\": \"Test456\",\n \"tracking_no_secondary\": null,\n \"sscc_barcode\": null,\n \"bill_of_lading\": null,\n \"total_cost\": null,\n \"package_weight_lbs\": null,\n \"dim_weight_lbs\": null,\n \"zone\": null,\n \"delivery_surcharge_type\": null,\n \"whs_location\": null,\n \"box_length_in\": null,\n \"box_width_in\": null,\n \"box_height_in\": null,\n \"date\": \"2016-08-27T06:05:05+00:00\",\n \"custom_1\": null,\n \"items\": [\n {\n \"item\": \"CIOPEN\",\n \"quantity\": \"1\",\n \"carton_code\": \"XXX1234YYY\",\n \"carton_num\": \"1\",\n \"box_length_in\": null,\n \"box_width_in\": null,\n \"box_height_in\": null,\n \"package_weight_lbs\": \"2.00\"\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"1025e904-adca-4a18-9eed-008971b84a6e"},{"name":"View Order","id":"94d24b6e-d8bf-46ea-bae3-c31c9fb97dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/merchant/orders/{{CUST_REF}}","description":"Returns the order with the specified CUST_REF, which is guaranteed to be unique for all orders for a merchant.
\nThe format of the order returned will match the format of an order passed to the New Order Cart level API Endpoint.
\nIt will also have a shipments element containing an array of tracking information matching the shipments format from the View Order Status Endpoint.
\nAny filters should be passed with the URL as GET arguments
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","orders","{{CUST_REF}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"41eadb1e-c1fb-4770-a7c2-05b68e63382e","name":"View Order","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/merchant/orders/{{CUST_REF}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"created_date_time\": \"2019-05-23T23:49:28+00:00\",\n \"updated_date_time\": \"2019-05-24T19:20:06+00:00\",\n \"record_no\": null,\n \"version\": null,\n \"format\": null,\n \"cust_ref\": \"TEST07Auto\",\n \"cust_po_no\": \"TEST07Auto\",\n \"po_number\": null,\n \"carrier\": null,\n \"ship_code\": \"\",\n \"ship_code_description\": null,\n \"working_ship_code\": null,\n \"cust_company\": \"Will Town\",\n \"cust_title\": null,\n \"cust_first_name\": null,\n \"cust_last_name\": null,\n \"cust_address_1\": \"351 Hatchback Way\",\n \"cust_address_2\": \"Suite B140\",\n \"cust_address_3\": null,\n \"cust_city\": \"Santa Lucia\",\n \"cust_state\": \"NV\",\n \"cust_zip\": \"93707\",\n \"cust_country\": \"USA\",\n \"cust_phone\": null,\n \"cust_e_mail\": null,\n \"ship_company\": \"Will Town\",\n \"ship_title\": null,\n \"ship_first_name\": null,\n \"ship_last_name\": null,\n \"ship_address_1\": \"351 HITCHCOCK WAY STE B140\",\n \"ship_address_2\": null,\n \"ship_address_3\": null,\n \"ship_city\": \"SANTA BARBARA\",\n \"ship_state\": \"CA\",\n \"ship_zip\": \"93105-4016\",\n \"ship_country\": \"USA\",\n \"ship_phone\": null,\n \"ship_e_mail\": null,\n \"ship_address_type\": null,\n \"special_services\": null,\n \"customer_id\": null,\n \"order_date\": \"2019-05-23\",\n \"sub_total\": \"0.00\",\n \"order_discount\": \"0.00\",\n \"sales_tax\": \"0.00\",\n \"shipping_handling\": \"0.00\",\n \"grand_total\": \"0.00\",\n \"balance\": \"0.00\",\n \"currency_code\": null,\n \"credit_card_no\": null,\n \"expiration_date\": null,\n \"pay_type\": \"CA\",\n \"tax_exempt_sw\": null,\n \"installment_program\": null,\n \"media_week\": null,\n \"order_source\": \"APIAccess1\",\n \"promo_code\": null,\n \"ani_phone\": null,\n \"vendor_phone\": null,\n \"check_account_no\": null,\n \"check_type\": null,\n \"check_no\": null,\n \"check_bank_id\": null,\n \"check_cust_bank\": null,\n \"check_cust_id_num\": null,\n \"check_cust_id_state\": null,\n \"check_cust_id_mm\": null,\n \"check_cust_id_dd\": null,\n \"check_cust_id_yy\": null,\n \"check_cust_id_type\": null,\n \"location\": null,\n \"shipping_instructions\": null,\n \"ship_account_no\": null,\n \"ship_account_zip\": null,\n \"pre_auth_code\": null,\n \"pre_auth_amt\": \"0.00\",\n \"pre_auth_id\": null,\n \"cvv\": null,\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"custom_field_4\": null,\n \"custom_field_5\": null,\n \"gift_card_sw\": null,\n \"token_sw\": null,\n \"cass_code_ship\": \"V\",\n \"cass_error_ship\": null,\n \"cass_code_cust\": \"N\",\n \"cass_error_cust\": null,\n \"cass_date\": null,\n \"ncoa_code_ship\": null,\n \"ncoa_code_cust\": null,\n \"ncoa_date\": null,\n \"error_code\": null,\n \"error_msg\": null,\n \"ifraud_error_code\": null,\n \"xfraud_error_code\": null,\n \"credit_error_code\": null,\n \"resubmit_date\": null,\n \"black_list\": null,\n \"credit_score\": null,\n \"fraud_score\": null,\n \"load_override_sw\": null,\n \"fail_action\": null,\n \"action_dt\": null,\n \"filename\": null,\n \"call_queue\": null,\n \"clerk_disposition\": null,\n \"clerk_disp_dt\": null,\n \"rep_disposition\": null,\n \"rep_disp_dt\": null,\n \"duplicate_sw\": null,\n \"weight\": null,\n \"org_file_no\": null,\n \"gift_message\": null,\n \"gift_wrap\": null,\n \"delete_date\": null,\n \"routing_sw\": \"N\",\n \"sent_to_region\": null,\n \"accepted_by_region\": null,\n \"regional_center\": null,\n \"regional_order_no\": null,\n \"regional_ship_date\": null,\n \"regional_retry_sw\": \"N\",\n \"regional_error\": null,\n \"regional_attempts\": \"0\",\n \"first_attempt\": null,\n \"cancel_date\": null,\n \"changed_by\": \"Shopping Cart: cartrover\",\n \"changed_from_server\": \"william-pc\",\n \"changed_by_user\": \"williamw\",\n \"cc_last_four\": null,\n \"expected_delivery_date\": null,\n \"requested_ship_date\": null,\n \"latest_ship_date\": null,\n \"delivered_to_wms_date\": \"2019-05-24T19:20:06+00:00\",\n \"shipment_pk\": null,\n \"error_reason\": null,\n \"mark_in_progress_date\": null,\n \"extra_system_date_sent\": null,\n \"sending_canceled\": \"N\",\n \"shipping_pickup_canceled\": \"N\",\n \"on_hold\": \"N\",\n \"inventory_warehouse_pk\": \"1979\",\n \"items\": [\n {\n \"line_no\": \"1\",\n \"item\": \"C100\",\n \"lot_number\": null,\n \"quantity\": \"2\",\n \"price\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"addl_discount\": \"0.0000\",\n \"extended_amount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping_surcharge\": \"0.00\",\n \"line_item_id\": null,\n \"line_comment\": null,\n \"Description\": null,\n \"alt_sku\": null,\n \"filtered_sku\": \"N\",\n \"line_location\": \"\"\n },\n {\n \"line_no\": \"2\",\n \"item\": \"C300\",\n \"lot_number\": null,\n \"quantity\": \"1\",\n \"price\": \"0.0000\",\n \"discount\": \"0.0000\",\n \"addl_discount\": \"0.0000\",\n \"extended_amount\": \"0.00\",\n \"tax\": \"0.00\",\n \"shipping_surcharge\": \"0.00\",\n \"line_item_id\": null,\n \"line_comment\": null,\n \"Description\": null,\n \"alt_sku\": null,\n \"filtered_sku\": \"N\",\n \"line_location\": \"\"\n }\n ],\n \"shipments\": []\n }\n}"},{"id":"9fdaaec3-7db6-46ff-b1b7-f3a6fedaaf8d","name":"View Invalid Order","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/merchant/orders/{{CUST_REF}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": false,\n \"error_code\": \"Invalid\",\n \"message\": \"Missing or invalid parameter: cust_ref - No such order found.\"\n}"}],"_postman_id":"94d24b6e-d8bf-46ea-bae3-c31c9fb97dcb"},{"name":"View Order Status","id":"6754ef38-98d9-4d4e-be8a-f8a7935dada9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/merchant/orders/status/{{CUST_REF}}","description":"This will return the order status and tracking information for the specified CUST_REF.
\nCUST_REF is guaranteed to be unique for all orders for a merchant.
\nUpdates the status of the order with the specified cust_ref and returns the new status as if using the View Order Status endpoint.
\nConsider using Batch Mode instead to avoid API rate limits.
\nThis endpoint can be called multiple times for a single order (with different tracking numbers) to add multiple shipment records to a single order, even if both shipments aren't on the same day.
\nMarks orders as successfully delivered to the WMS. This step is crucial for inventory levels and avoiding downloading new orders multiple times.
\nConsider using Batch Mode instead to avoid API rate limits.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","orders","update","{{CUST_REF}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"cda70a9c-5a24-465d-8d8a-ad5806ae1a0e","name":"Update Order Status - At WMS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{\"order_status\":\"at_wms\"}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/merchant/orders/update/{{CUST_REF}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"cust_ref\": \"ABC123\",\n \"cust_po_no\": \"ABC123\",\n \"delivered_to_wms_date\": \"2021-09-21T23:55:06+00:00\",\n \"updated_date_time\": \"2021-09-21T23:55:06+00:00\",\n \"ship_country\": \"USA\",\n \"order_status\": \"at_wms\",\n \"shipments\": []\n }\n}"}],"_postman_id":"d41c4f1c-c820-4155-8c6d-a0220341c52f"},{"name":"Batch Update Order Status","id":"10455179-de02-470e-8768-65ba88c76178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"cust_ref\": {{CUST_REF}},\n \"order_status\": \"at_wms\"\n },\n {\n \"cust_ref\": {{CUST_REF}},\n \"order_status\":\"shipped\",\n \"shipments\":[\n {\n \"tracking_no\": \"Test123\",\n \"date\": \"2016-08-27T04:04:04+00:00\",\n \"carrier\": \"UPS\",\n \"method\": \"20\"\n },\n {\n \"tracking_no\": \"Test456\",\n \"date\": \"2016-08-27T05:05:05+00:00\",\n \"carrier\": \"FEDEX\",\n \"method\": \"50\"\n }\n ]\n \n }\n]"},"url":"{{BASE_URL}}/v1/merchant/orders/update","description":"Batch updates the status up to 100 orders at a time and returns a success response for each individual order.
\nThis endpoint can be called multiple times for a single order (with different tracking numbers) to add multiple shipment records to a single order, even if both shipments aren't on the same day.
\nPass a numeric array of orders to update, each containing the following fields:
\nThis will attempt to cancel the specified order in both CartRover and the WMS. The response will specify whether or not the order was able to be canceled.\n
\nNote: This call may take longer than others because CartRover will reach out to the WMS in real time and wait for a response.
This will attempt to cancel/refund orders with the originating order source/cart by specifying Shipment and Line items to cancel/refund. The cart's response will be returned. Not all carts support this functionality.
\nYou may also find the Cancel/Refund Order Logs API endpoint useful to lookup previous cancellation requests.
\nNote: This call may take longer than others because CartRover will reach out to the shopping cart in real time and wait for a response.
\nNote: API call is limited to 10 orders per request.
\nReturns inventory levels for all products from the warehouse.
\nNote: Any filters should be passed with the URL as GET arguments.
\nNumber of products to return at once. Default 20, max 100
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"Page of results to return. Default 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"7f0ea7e1-54f3-45b3-bddc-65956fb86921","name":"List Inventory","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cartrover.com/v1/merchant/inventory?limit=20&page=1","protocol":"https","host":["api","cartrover","com"],"path":["v1","merchant","inventory"],"query":[{"key":"limit","value":"20","description":"Number of products to return at once. Default 20, max 100"},{"key":"page","value":"1","description":"Page of results to return. Default 1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": [\n {\n \"sku\": \"CIO-1001\",\n \"qty_available\": 10,\n \"qty_on_hand\": 15,\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\",\n \"aliases\": {\n \t\"ALT_CODE\": \"Some Alt Code\",\n \t\"UPC\": \"SomeUPCCode\"\n },\n \"warehouses\": {\n \"2352\": {\n \"warehouse\": \"EAST\",\n \"qty_available\": 10,\n \"qty_on_hand\": 15,\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\"\n }\n }\n },\n {\n \"sku\": \"CIO-1002\",\n \"qty_available\": 20,\n \"qty_on_hand\": 20,\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\",\n \"aliases\": [],\n \"warehouses\": {\n \"2352\": {\n \"warehouse\": \"EAST\",\n \"qty_available\": 20,\n \"qty_on_hand\": 20,\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\"\n }\n }\n },\n {\n \"sku\": \"CIO-1003\",\n \"qty_available\": 30,\n \"qty_on_hand\": 30,\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\",\n \"aliases\": [],\n \"warehouses\": {\n \"2352\": {\n \"warehouse\": \"EAST\",\n \"qty_available\": 10,\n \"qty_on_hand\": 10,\n \"wms_datetime\": \"2014-01-14T01:48:07+00:00\"\n },\n \"2489\": {\n \"warehouse\": \"WEST\",\n \"qty_available\": 20,\n \"qty_on_hand\": 20,\n \"wms_datetime\": \"2014-01-14T01:48:07+00:00\"\n }\n }\n }\n ]\n}"}],"_postman_id":"a5e6259b-0ffe-4303-ab51-af77937a631c"},{"name":"List Cart Inventory","id":"9237fa1c-9d23-4c60-915e-379ebd88b928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/inventory/{{ORDER_SOURCE}}","description":"Returns last known inventory levels for a specific cart. This is cached data that can be used to determine which SKUs exist for a given order source as well as what products and inventory levels the order source last reported (Generally refreshed every 4 hours). It may not be available for all carts at all times. Use the List Inventory endpoint to see what products and inventory CartRover actually has on file for the merchant.
\nNotices:
\nNote: Any filters should be passed with the URL as GET arguments.
\nNumber of products to return at once. Default 20, max 100
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"Page of results to return. Default 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"46a60a4e-167b-4370-92fc-7d1865767dd8","name":"List Cart Inventory","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cartrover.com/v1/cart/inventory/Shopify2?limit=20&page=1","protocol":"https","host":["api","cartrover","com"],"path":["v1","cart","inventory","Shopify2"],"query":[{"key":"limit","value":"20","description":"Number of products to return at once. Default 20, max 100"},{"key":"page","value":"1","description":"Page of results to return. Default 1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": [\n {\n \"sku\": \"Sample_item_2\",\n \"product_id\": \"1623500357750\",\n \"product_variant_id\": \"14764751388790\",\n \"product_type\": \"physical\",\n \"site_inventory_enabled\": true,\n \"last_cart_inventory\": \"1195\",\n \"date_checked\": \"2021-02-04T20:55:50+00:00\"\n },\n {\n \"sku\": \"Sample_item_3\",\n \"product_id\": \"1623571202166\",\n \"product_variant_id\": \"14765643202678\",\n \"product_type\": \"physical\",\n \"site_inventory_enabled\": true,\n \"last_cart_inventory\": \"983\",\n \"date_checked\": \"2021-02-04T20:55:49+00:00\"\n },\n {\n \"sku\": \"zyx-123\",\n \"product_id\": \"2050530345078\",\n \"product_variant_id\": \"19361806745718\",\n \"product_type\": \"physical\",\n \"site_inventory_enabled\": true,\n \"last_cart_inventory\": \"-2\",\n \"date_checked\": \"2021-02-04T20:55:50+00:00\"\n }\n ]\n}"}],"_postman_id":"9237fa1c-9d23-4c60-915e-379ebd88b928"},{"name":"Update Inventory","id":"ee5af99e-5ad9-4781-8b69-9aff686339b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"sku\": \"CIO-1001\",\n \"qty_available\": \"11\",\n \"qty_on_hand\": \"15\"\n },\n {\n \"sku\": \"CIO-1002\",\n \"qty_available\": \"22\",\n \"qty_on_hand\": \"20\",\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\"\n },\n {\n \"sku\": \"CIO-1003\",\n \"qty_available\": \"33\",\n \"qty_on_hand\": \"30\",\n \"wms_datetime\": \"2016-08-27T02:24:58+00:00\"\n },\n {\n \"sku\": \"CIO-1004\"\n }\n]"},"url":"{{BASE_URL}}/v1/merchant/inventory/update","description":"Updates the inventory levels for products in CartRover. Inventory levels will be pushed to the Order Sources based on each cart's settings. CartRover will keep track of sales between the time you make this call and when the inventory is pushed to the shopping cart. If you pass a SKU that does not exist for the merchant in CartRover, it will be created dynamically and synced to any carts which have a matching SKU.
\nNote: There is an API call limit of 100 products per call.
\nReturns inventory levels for the specified product from the warehouse.
\nThe qty_available inventory levels of each warehouse entry when added together may not match the summary qty_available field. This is because recent sales for each location cannot be subtracted from available quantity for a specific location if CartRover does not know how they will route. The summary inventory level will always be accurate.
\nReturns the product and alias details for the specified product from the warehouse.
\nNote: The SKU you use to lookup the product can be either a Master SKU in CartRover, or an alias code. Either match will return the product result.
\nUpdate product and alias details for the specified product SKU.\n
\nNote: The SKU you use to lookup the product can be either a Master SKU in CartRover, or an alias code. Either match will update and return the product result. If no match is found, an error is returned.
Note: This endpoint can not currently create a new product. Only update existing ones. To create a new product, call Update Inventory which will create a new product if the SKU passed is new.
\nNULL to remove specified Alias Type from the product's Alias list.List of standard Extra Fields:
\nIf using these Extra Field Names, CartRover can sync full product details with any Order Source that supports Product Detail Sync.
\n { \"extra_fields\": {\"attribute_names\": [ \"color\", \"size\", \"fabric\" ], \"color\": \"red\", \"size\": \"large\", \"fabric\": \"silk\"} }Marketplace Specific Fields
\nEbay
\nJoor
\nReturns all outstanding alerts for this merchant.
\nAll filters should be passed in the URL as GET arguments.
\nDismiss oustanding alerts for this merchant.
\nBody should be one or more notification_pk obtained from GET List Alerts
If there are other alerts for the same merchant with the same subject as one of the notification_pk submitted, they will be dismissed as well without their notification_pk needing to be submitted.
Retrieves an order's cancel/refund logs by using cust_ref.
\nThis endpoint takes a specific order_source and returns the list of ship methods that have been seen from that order source. This can be used to map codes to WMS codes. This list will be automatically populated as new codes are seen from the order source.
\nA list of order sources for each merchant can be found using the endpoint: List Setup Carts: /cart/list
\nReturns an array of records, each record containing the following fields:
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","cart","shipmethod","list","{{ORDER_SOURCE}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"5400267c-d719-406a-b85e-cdf8cce0497a","name":"Cart Ship Method List","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/cart/shipmethod/list/shopify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"\r\n{\r\n \"success_code\": true,\r\n \"response\": [\r\n {\r\n \"cart_code\": \"\",\r\n \"wms_code\": \"01\",\r\n \"description\": \"USPS First Class Mail\",\r\n \"last_seen\": \"2016-08-27T02:24:58+00:00\"\r\n },\r\n {\r\n \"cart_code\": \"standard\",\r\n \"wms_code\": \"09\",\r\n \"description\": \"USPS Priority Mail\",\r\n \"last_seen\": \"2016-08-27T02:24:23+00:00\"\r\n }\r\n ]\r\n}"}],"_postman_id":"850114aa-7597-4af6-8920-3a97646c7ebb"},{"name":"Update Cart Ship Methods Mapping","id":"8ddc8fcf-11e1-4034-89b7-97d27cd8c60f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"cart_code\": \"23\",\n \"wms_code\": null\n },\n {\n \"cart_code\": \"UPS Freight\",\n \"wms_code\": \"20\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/shipmethod/list/{{ORDER_SOURCE}}","description":"This endpoint takes a specific order_source and a list of ship methods to be mapped into specific WMS supported codes. Submitted cart_codes will be added to cart Ship Method list if new, and updated if already existing.
\nA list of order sources for each merchant can be found using the endpoint: List Setup Carts: /cart/list
\nA list of allowed WMS codes can be found using the endpoint: List WMS Ship Methods: /wms/shipmethod/list
\nSubmit an array of records, each record containing the following fields:
\nReturns the input array of loaded records on success.
\nOn failure, returns the following fields:
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","cart","shipmethod","list","{{ORDER_SOURCE}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"ee284638-5608-472d-9638-33c52c408981","name":"Update Mapping Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"cart_code\": \"23\",\n \"wms_code\": null\n },\n {\n \"cart_code\": \"UPS Freight\",\n \"wms_code\": \"20\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/shipmethod/list/shopify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success_code\": true,\r\n \"response\": [\r\n {\r\n \"cart_code\": \"23\",\r\n \"wms_code\": null\r\n },\r\n {\r\n \"cart_code\": \"UPS Freight\",\r\n \"wms_code\": \"74\"\r\n }\r\n ]\r\n}"},{"id":"9ff1a55d-aafa-4395-b7b6-ab9041413574","name":"Update Mapping Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"cart_code\": \"23\",\n \"wms_code\": null\n },\n {\n \"cart_code\": \"UPS Freight\",\n \"wms_code\": \"20\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/shipmethod/list/shopify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success_code\": false,\r\n \"error_code\": \"Invalid\",\r\n \"message\": \"Some cart_codes failed\",\r\n \"error_response\": {\r\n \"failed_entries\": [\r\n {\r\n \"cart_code\": \"UPS Freight\",\r\n \"reason\": \"Invalid parameter: wms_code - No such code found.\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"8ddc8fcf-11e1-4034-89b7-97d27cd8c60f"},{"name":"List WMS Ship Methods","id":"3714ab8d-3671-41fc-8618-cc3a2cc13329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/wms/shipmethod/list","description":"Returns an array of acceptable warehouse ship methods. No parameters are required.\n
\nNote: This list is unlikely to change often, or ever at all. We recommend you cache/store this list and either update it occasionally or as needed on-demand
Note: The codes and descriptions returned are defined by the warehouse and not CartRover. They may differ from what you see here.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","wms","shipmethod","list"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3714ab8d-3671-41fc-8618-cc3a2cc13329"},{"name":"List Skipped Orders","id":"e7771a66-b86e-4637-902a-d472cfb6d10b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/merchant/skipped_orders","description":"Returns a list of all skipped orders matching the given arguments. Skipped orders are orders sent to CartRover but not loaded because they did not match all required filters (eg. status, date, country filter, etc). Orders will not appear in this list if the order source filtered them out before sending them to CartRover.
\nAny arguments should be passed with the URL as GET arguments.
\nThe response will contain an array of skipped orders and include the filter reason, filter date and the filter value if applicable.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","merchant","skipped_orders"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7771a66-b86e-4637-902a-d472cfb6d10b"},{"name":"New Cart","id":"b5e3f171-535d-492f-9f31-ffe7a9d4a033","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cart_id\": \"Amazon_US\",\n \"user_key\": \"123AMAZONSELLERID456\",\n \"password\": \"123MWSAUTHTOKEN456\",\n \"description\": \"USA Seller Fulfilled\",\n \"schedules\": {\n \"order\": \"0\",\n \"confirm\": \"20\",\n \"inventory\": \"5\"\n },\n \"extra_params\": {\n \"item_field\": \"ASIN\",\n \"refund_delay\": \"N\",\n \"prime_ship_code\": \"PrimeOrder\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/v1/cart/new","description":"Set up a new Order Source connection to CartRover
\nGet the details for a specific order source setup. Some API credentials provided when setting up the connection may not be returned in this call.
\nUpdate the settings for a specific order source connection.
\nMerchant API calls are available to users with merchant level credentials. These endpoints allow for common actions that a warehouse or merchant would want to perform in order to receive, and ship their orders.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4c5bdc4c-81f4-418c-b0c4-2d5128fa65cc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"261194c0-0d07-4184-8b68-1361556798d2"}}],"_postman_id":"f4558d8d-942a-4bdc-985c-38ca3308e8c7","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}}},{"name":"Warehouse API","item":[{"name":"List WMS Params","id":"520e9d35-6a9c-42ca-8d2d-7048fae205ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{BASE_URL}}/v1/wms/params","description":"Get a list of parameters used to configure this warehouse. This will include the available parameters for the following levels: WMS, Merchant, Cart.
\nThis call is available to both Warehouse and Merchant accounts, but not merchants within a Warehouse account.
\nEdit WMS info including WMS System and wms parameters. Any fields left off will be left as-is.
\nThis call is available to both Warehouse and Merchant accounts, but not merchants within a Warehouse account.
\nCreates a new merchant user and returns API credentials for that merchant.
\nReturns an array of acceptable warehouse ship methods. No parameters are required.\n
\nNote: This list is unlikely to change often, or ever at all. We recommend you cache/store this list and either update it occasionally or as needed on-demand
Note: The codes and descriptions returned are defined by the warehouse and not CartRover. They may differ from what you see here.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","wms","shipmethod","list"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"87e4e22e-21fe-4d8c-a59e-ba292e91eea5","name":"WMS Ship Method List","originalRequest":{"method":"GET","header":[],"url":"https://api.cartrover.com/v1/wms/shipmethod/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success_code\": true,\r\n \"response\": [\r\n {\r\n \"code\": \"01\",\r\n \"description\": \"USPS First Class Parcel\",\r\n \"carrier\": \"USPS\"\r\n },\r\n {\r\n \"code\": \"09\",\r\n \"description\": \"USPS Priority Mail\",\r\n \"carrier\": \"USPS\"\r\n },\r\n {\r\n \"code\": \"28\",\r\n \"description\": \"UPS Next Day Air\",\r\n \"carrier\": \"UPS\"\r\n },\r\n {\r\n \"code\": \"50\",\r\n \"description\": \"FedEx Ground\",\r\n \"carrier\": \"FEDEX\"\r\n },\r\n {\r\n \"code\": \"DB\",\r\n \"description\": \"DHLGM Parcel Intl Standard\",\r\n \"carrier\": \"\"\r\n }\r\n ]\r\n}"}],"_postman_id":"eece9c31-9f53-4e68-8ce7-44bf032545f4"},{"name":"List Merchants","id":"18bfbb5e-1cbb-460e-b6c6-67cd966da156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/wms/merchant/list","description":"This will return all merchants belonging to the WMS account.
\nThe response is a numerically indexed array with each element containing the following keys.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","wms","merchant","list"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0d6dfffa-bd93-4a22-aaff-6ec938abe068","name":"WMS Merchant List","originalRequest":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/wms/merchant/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": [\n {\n \"merchant_pk\": \"265\",\n \"name\": \"test-1-merchant-1\"\n },\n {\n \"merchant_pk\": \"278\",\n \"name\": \"test-1-merchant-2\"\n },\n {\n \"merchant_pk\": \"279\",\n \"name\": \"test-1-merchant-3\"\n },\n {\n \"merchant_pk\": \"280\",\n \"name\": \"test-11@sample.com\"\n }\n ]\n}"}],"_postman_id":"18bfbb5e-1cbb-460e-b6c6-67cd966da156"},{"name":"Get Merchant","id":"44428464-3e61-4dd0-ae88-d51811d503f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/wms/merchant/{{MERCHANT_PK}}","description":"This will return details for the specified merchant.
\nThe response element will contain the following keys.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","wms","merchant","{{MERCHANT_PK}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f30ea0d5-e3f8-42c8-ba58-5704aa5de522","name":"Get Merchant","originalRequest":{"method":"GET","header":[],"url":"https://api.cartrover.com/v1/wms/merchant/{{MERCHANT_PK}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Oct 2025 15:42:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"X-CartRover-Process-ID","value":"229083-31ZJPttix0"},{"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=4o7cd90eaju281ono51o5dbhqr; path=/; secure; HttpOnly; SameSite=None; Partitioned"}],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"name\": \"JP\",\n \"merchant_pk\": \"809\",\n \"merchant_params\": {\n \"partner_id\": \"\",\n \"customer_code\": \"\",\n \"company_code\": \"\",\n \"extra_wms_interface\": \"\",\n \"tradegecko_prod_details\": \"N\",\n \"tradegecko_pickup_cancel\": \"N\",\n \"tradegecko_composite_products\": \"Y\",\n \"owner_setup_key\": \"B6Dq5gzb\"\n },\n \"schedules\": {\n \"order\": 0,\n \"shipment\": 0,\n \"inventory\": 0\n },\n \"schedules_available\": {\n \"order\": {\n \"0\": \"OFF\",\n \"5\": \"Every Fifteen Minutes\",\n \"2\": \"Every Hour\",\n \"3\": \"Around Midnight\",\n \"15\": \"Every Half Hour\",\n \"18\": \"Every Five Minutes\"\n },\n \"shipment\": {\n \"0\": \"OFF\",\n \"20\": \"Automatic\",\n \"2\": \"Every Hour\",\n \"3\": \"Around Midnight\",\n \"6\": \"Every Fifteen Minutes\",\n \"15\": \"Every Half Hour\"\n },\n \"inventory\": {\n \"0\": \"OFF\",\n \"20\": \"Automatic\",\n \"2\": \"Every Hour\",\n \"3\": \"Around Midnight\",\n \"7\": \"Every Fifteen Minutes\",\n \"15\": \"Every Half Hour\"\n }\n },\n \"discontinued\": false\n }\n}"}],"_postman_id":"44428464-3e61-4dd0-ae88-d51811d503f2"},{"name":"Cancel/Refund Order in Cart","id":"ce765ecc-8c07-4f1c-a29a-20ff8903652c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"cust_ref\" : \"TEST01\",\n \"merchant_pk\" : 2319,\n \"cancel_order\" : true,\n \"shipment\" : {\n \"full_shipping_refund\": true\n }\n },\n {\n \"cust_ref\" : \"TEST99\",\n \"merchant_pk\" : 2319,\n \"cancel_order\" : true,\n \"shipment\" : {\n \"full_shipping_refund\": true\n }\n }\n]"},"url":"{{BASE_URL}}/v1/wms/orders/cart_cancel","description":"This will attempt to cancel/refund orders with the originating order source/cart by specifying Shipment and Line items to cancel/refund. The cart's response will be returned. Not all carts support this functionality.
\nYou may also find the Cancel/Refund Order Logs API endpoint useful to lookup previous cancellation requests.\n
\nNote: This call may take longer than others because CartRover will reach out to the shopping cart in real time and wait for a response.\n
\n
\nNote: API calls are limited to 10 orders per API Call.
Retrieves an order's cancel/refund logs by using cust_ref.
\nWarehouse API calls are only available to users with Warehouse level credentials. These endpoints allow for a warehouse, 3PL, or software provider to manage many merchants at the same time.
\nWarehouse account API credentials may also be used to access any Merchant level API calls for accounts they own by passing the following header values (along with the Warehouse API Keys) to identify the desired sub-account with each request:
\nExample: X-Merchant-Pk: 1234
\nWarehouse account credentials can not be used to access any Cart API calls.
\nEach merchant accessed has its own separate rate limit.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e310676e-80cb-4988-98cc-b523d1c563c9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"aa2e4c27-9114-42a7-9472-b91621d6eb48"}}],"_postman_id":"52707280-0b48-477a-92f7-af974fed75fb","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Order Update Webhook","id":"b86696ca-44be-4480-8f89-485400078f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"The Order Update webhook will be triggered for Cart API keys when the status of an order has changed.
\nThe following events trigger this webhook:
\nOrder Shipped by Warehouse
\nOrder Reloaded by Cart (CSV or API carts only are allowed to do this)
\nThe following value will be posted in the X-Webhook-Event header: order_update
\nThe orders array may contain multiple records if several orders have been updated within a narrow timeframe.
\nSee View Order Status or sample webhook for a full list of Order and Shipment fields returned
\nUpon a successful 200 response, the order shipment will be marked as confirmed indicating you have received the tracking information.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"46852c62-eb7e-44a2-95e5-3876b9db3cc8","id":"46852c62-eb7e-44a2-95e5-3876b9db3cc8","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[{"id":"bca167c9-e1d5-4b97-9d1e-28cd443a3dec","name":"Order Update Webhook","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"X-Webhook-Event","value":"order_update","type":"text"},{"key":"X-Webhook-Signature","value":"SHA-256 signed HMAC of the body","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Webhook-Event","value":"order_update","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"orders\": [{\r\n \"cust_ref\": \"349347\",\r\n \"cust_po_no\": \"349347\",\r\n \"delivered_to_wms_date\": \"2016-04-24T22:19:16+00:00\",\r\n \"order_status\": \"shipped\",\r\n \"shipments\": [{\r\n \"carrier\": \"USPS\",\r\n \"method\": \"09\",\r\n \"tracking_no\": \"9405510899046006477740\",\r\n \"tracking_no_secondary\": null,\r\n \"total_cost\": \"1.50\",\r\n \"package_weight_lbs\": \"0.50\",\r\n \"dim_weight_lbs\": null,\r\n \"zone\": null,\r\n \"delivery_surcharge_type\": null,\r\n \"date\": \"2016-04-25T22:19:16+00:00\",\r\n \"custom_1\": null,\r\n \"items\": [\r\n {\r\n \"item\": \"CIOPEN\",\r\n \"quantity\": \"1\",\r\n \"carton_code\": \"XXX1234YYY\",\r\n \"carton_num\": \"1\",\r\n \"box_length_in\": null,\r\n \"box_width_in\": null,\r\n \"box_height_in\": null,\r\n \"package_weight_lbs\": \"2.00\"\r\n }\r\n ]\r\n }]\r\n }]\r\n}"}],"_postman_id":"b86696ca-44be-4480-8f89-485400078f0b"},{"name":"Order New Webhook","id":"509f7fe0-20d3-4a62-80ef-683571ba2d20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"The Order Update webhook will be triggered for Merchant API keys when a new order is loaded in CartRover.
\nThe following events trigger this webhook:
\nThe following value will be posted in the X-Webhook-Event header: order_new
\nThe orders array may contain multiple records if several orders have been updated within a narrow timeframe.
\nSee New Order or sample webhook endpoint for a full list of order and item fields.
\nNote: The status of an order is not changed automatically when you receive a webhook.
\nUpon a successful 200 response, the order will be marked as at_wms indicating you have received the order.
Webhooks are a tool that allows your application to listen for and respond to specific events within CartRover as they happen. Rather than having to reach out and check if an event has occurred, CartRover will reach out and notify your application when it has.
\nBecause webhooks originate from CartRover, you will need a publically available URL in order for them to work properly.
\nNote: CartRover uses the following IP addresses which you may need to whitelist: 50.18.194.14, 54.241.171.180
\nIn the API Settings, fill out the Optional Webhook URL where CartRover should post data to. If you need CartRover to pass a custom header with each request, you can also enter that information here as well. As soon as you have saved the Webhook URL, you will be subscribed to events.
\nWebhook data will be POSTed to the specified URL as a JSON string in the body. Below are a few examples of how to receive the data.
\n$body = file_get_contents('php://input');\n\nfrom flask import request\nbody = request.data\n\nbody = request.raw_post\n\nTo acknowledge that you have properly received the data from a webhook post, you must respond with a http status of 200. Any other http status will be considered a failure. You do not need to return anything in the body of the response. If you do return a body, it will be ignored.
\nIf you fail to properly respond to a webhook for any reason, it will be automatically re-attempted up to ten times based on the inverse of the natural log.
\nCalculation for wait time before next retry:
\n\n\nceiling(e^x)
\n
Where x stands for the number of failed attempts and the result is the number of minutes before the next attempt. Eg: If the webhook post has failed 3 times, the next attempt will be in ceiling(e^3) minutes, or 21 minutes.
\nEach Webhook post will include a X-Webhook-Event header identifying the specific Webhook event which was triggered. View the event specific documentation below to see what value will be passed for each.
\nCartRover will also include a header named X-Webhook-Signature with every post. The value of this header will be a SHA-256 signed HMAC of the body of the post. Your CartRover API Key will be used as the key for the HMAC.
\nIf you do not verify the headers in the post, you cannot guarantee the message came from CartRover.
\nHere are some examples of how you can verify this signature in your code:
\n$api_key = 'CARTROVER_API_KEY';\n$msg_body = file_get_contents('php://input');\n$signature_sent = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'];\n$signature_generated = hash_hmac('sha256', $msg_body, $api_key);\nif(!hash_equals($signature_generated, $signature_sent)){\n // You are not CartRover!\n exit(0);\n}\n\nimport hmac\nfrom hashlib import sha256\napi_key = 'CARTROVER_API_KEY'\nmsg_body = request.data\nsignature_generated = hmac.new(api_key, msg_body, sha256).hexdigest()\n\nrequire 'base64'\nrequire 'openssl'\napi_key = 'CARTROVER_API_KEY'\nmsg_body = request.body.read\nsignature_generated = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, api_key, msg_body)\n\nYou can also use the optional custom header name/value pair to verify that the request is coming from CartRover. In this case it is up to you to enter secure header values and keep them secret.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7d5d93ac-ac89-403f-b4c4-f7c15cd0b4a0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cd6f00a-2306-4a16-8c4b-789f2315bb58","type":"text/javascript","exec":[""]}}],"_postman_id":"46852c62-eb7e-44a2-95e5-3876b9db3cc8"},{"name":"Master API","item":[{"name":"List Sub Accounts","id":"742337dc-e34a-46ca-bc61-1c6d1f9ac84b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BASE_URL}}/v1/master/list_sub","description":"Get a list of all Sub Accounts
\nNote: Any filters should be passed with the URL as GET arguments.
\nwarehouses is a numerically indexed array with each element containing the following keys.
\nmerchants is a numerically indexed array with each element containing the following keys.
\n","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}},"urlObject":{"path":["v1","master","list_sub"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"39f0867e-80d6-430f-abe6-9a10f7582a99","name":"Master Sub Account List","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/v1/master/list_sub?include_discontinued=N","host":["{{BASE_URL}}"],"path":["v1","master","list_sub"],"query":[{"key":"include_discontinued","value":"N"},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success_code\": true,\n \"response\": {\n \"warehouses\": [\n {\n \"fclient_pk\": \"227\",\n \"company\": \"My TEST FF\",\n \"discontinued_sw\": \"N\"\n }\n ],\n \"merchants\": [\n {\n \"merchant_pk\": \"862\",\n \"company\": \"Big Hats\",\n \"discontinued_sw\": \"N\"\n },\n {\n \"merchant_pk\": \"861\",\n \"company\": \"Car Part Depot\",\n \"discontinued_sw\": \"N\"\n }\n ]\n }\n}"}],"_postman_id":"742337dc-e34a-46ca-bc61-1c6d1f9ac84b"},{"name":"New Merchant Sub Account","id":"e0853649-8985-48fc-a0d6-19b7d640e4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"company\": {\r\n \"company\": \"My Company Name\",\r\n \"phone\": \"1-805-399-2278\"\r\n },\r\n \"user\": {\r\n \"name\": \"Mrs. Bigglesworth\",\r\n \"email\": \"biggle@evil.com\",\r\n \"password\": \"Optional Password\",\r\n \"repeat_password\": \"Optional Password\"\r\n }\r\n}"},"url":"{{BASE_URL}}/v1/master/merchant","description":"Create a new Standalone Merchant account.
\nCreate a new Warehouse / 3PL account.
\nMaster API calls are only available to software providers or partners managing multiple accounts or whitelabeling CartRover. You must have a CartRover Master Account to access these. These endpoints allow for a company to manage multiple CartRover accounts at the same time.
\nMaster account API credentials may also be used to access any Warehouse or Merchant level API calls for accounts they own by passing the following header values (along with the Master API Keys) to identify the desired sub-account with each request:
\nExample: X-Fclient-Pk: 1234
\nMaster account credentials can not be used to access any Cart API calls.
\nEach sub account has its own separate rate limit.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ec1dead1-18d6-4383-8299-353f35423686"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9b4e51bd-5743-41b5-919e-af3597268bc9"}}],"_postman_id":"17a1bb15-2391-4b23-9ca7-78f8deacd889","auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"},"isInherited":true,"source":{"_postman_id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","id":"6078c445-8180-4d8e-8a05-fd5b9e5dbb6c","name":"CartRover API","type":"collection"}}},{"name":"Sample Workflows","item":[{"name":"Warehouse or OMS Sample Workflow","item":[],"id":"81e582ab-a059-4df0-9f25-a3e3e3212a08","description":"This sample API workflow covers common functionality that a Warehouse or Order Management System might use when connecting to CartRover via API. We recommend reviewing the main API documentation first which covers things like Authentication and Error handling.
\nUse the Merchant List Orders by Status: /merchant/orders/list/ endpoint and pass new as the status.
\nNote: This step is not currently available as a webhook, but this is planned for a future update.
\nUse the Merchant Update Order Status: /merchant/orders/update/ endpoint to update the order status to at_wms once you've loaded the orders. This will let the merchant know via the web screens which orders have been loaded, and will also make sure you don't receive the same orders over and over each time you download new orders. This step is critical to ensure inventory calculations inside CartRover are accurate.
\nUse the Merchant Update Order Status: /merchant/orders/update/ endpoint again to update the order status to shipped. When marking orders as shipped, the post data also requires a shipments element where you can pass a list of boxes and tracking numbers. If your systems knows the details of which items shipped in which box and other carton details, we recommend passing that data. The minimum required shipment data is a tracking number. If no box or item details are provided, CartRover will assume the entire order was shipped. You can make multiple calls to this endpoint for the same order if multiple packages for the same order ship at different times.
\nUse the Merchant Update Inventory: /merchant/inventory/update endpoint to post inventory data to CartRover. This information will be forwarded to the order sources connected to CartRover. You can either provides these updates real-time as adjustments occur in your system, or in batches on a regular schedule. CartRover will keep track of sales in between inventory posts to make sure the levels passed to the order sources are correct and account for sales that happened after you posted the inventory data.
\nThis sample API workflow shows how you can integrate CartRover tightly into your system and whitelabel much of the functionality. This guide will cover setting up new merchants and order source connections in the background via API calls.
\nNote that some connections that require oAuth either cannot be fully white labeled, or require a closer partnership with CartRover in order to fully white label them.
\nUse the New Merchant: /wms/merchant endpoint to create a new merchant user. This will also return API credentials for that merchant. This call uses your Warehouse level API credentials.
\nNotice: There is not currently a way to view the existing merchant API credentials or setup new merchant API credentials through the Warehouse API. The credentials are only returned once when the merchant is first created.
\nUse the New Merchant Sub Account: /master/merchant endpoint to create a new Merchant Account, or New Warehouse Sub Account: /master/warehouse endpoint to create a new Warehouse Account. This return the Account Number for the new account that can be used in subsequent calls. This call uses your Master level API credentials. For more info on accessing your sub-accounts see Sub Account Access.
\nUse the List All Available Carts: /cart/listall endpoint to display a list of available cart connections. This call also lists all required parameters to setup each cart. This call uses the merchant's level API credentials.
\nUse the New Cart: /cart/new endpoint to pass connection credentials and initial settings. CartRover will either save and verify the credentials or return an oauth redirect URL if the connection requires it.
\nUse the List Setup Carts: /cart/list endpoint to get a list of all order source connections currently set up.
\nUse the Get Cart: /cart/list/{order_source} endpoint to get the current settings for a specific order source connection.
\nUse the Update Cart: /cart/edit/{order_source} endpoint to update the credentals or settings for a specific order source connection.
\nUse the List Alerts: /merchants/alerts endpoint to get a list of all active alerts/issues for the merchant. This includes things like orders, tracking, and inventory records that failed to sync across and need to be reviewed/corrected.
\nOnce a new cart has been connected, see this guide for how to manage the orders: API Sample Workflow - Warehouse or OMS
\nThese sample workflows show the basic functionality you will need to implement for certain scenarios. These are a great guide to use to start with if they fit your integration type.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0a54e414-8541-4403-bc42-23775b4a520b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8db6be6d-b6a2-48fa-9478-6580dd50f759"}}],"_postman_id":"b877d3b4-6043-4c58-93a1-2d809347481e"}],"auth":{"type":"basic","basic":{"password":"{{api_key}}","username":"{{api_user}}"}},"event":[{"listen":"prerequest","script":{"id":"5e77313a-67be-4928-86ea-16a1642d89e2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d4825b0a-18d6-4779-9656-6b0886f597b1","type":"text/javascript","packages":{},"exec":[""]}}]}