This is the documentation of Forstok Application Programming Interface (API). This document contains the published Forstok API for our partners (channels).
\nAside of Authentication endpoint, Forstok API will have the following format :
\nhttps://integration.forstok.com/api/ {version} / {type} / {id} / {endpoint} / {params}
\nThere are two kinds of data delivery schemes from Forstok to our partners :
\nA. Using Open API
\nB. Using Webhook
\nTo access Forstok API, you must first authenticate yourself and get access token.
\nParams
\nResponse
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"To access Forstok API, you must first authenticate yourself and get access token.
\n","_postman_id":"8f84b894-b125-4f4a-a864-ccfe6ccc0bdc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description:
To be notified when certain events occur, you must register your callback url to the following endpoint. Be sure that your callback accepts HTTP POST method.
Event type option :
Product
product_create
\nproduct_update_attributes
\nproduct_update_stock
\nproduct_update_price
\nproduct_update_status
\nproduct_delete
\nOrder
\norder_update_payment_status
\norder_update_fulfillment_status
\norder_create_return
\norder_update_return
\norder_delete_return
\n\n\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","webhook","register"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"e36dd161-d284-4f38-912b-323f3fa320ef","name":"Register Webhook","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"callback\": \"www.somedomain.com/callback_url\",\n\t\"event\": \"product_create\"\n}"},"url":"https://integration.forstok.com/api/v2/channel/1/webhook/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 09:14:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"38abd122bddca8bd4771aed9a24912b3\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"d9540738-c944-4d9f-b140-333084ddff1c"},{"key":"X-Runtime","value":"0.366968"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"event\": \"product_create\",\n \"callback_url\": \"www.somedomain.com/callback_url\"\n },\n \"msg\": \"Success create webhook.\"\n}"},{"id":"2ce75514-63c9-4763-b17f-d9112d39c89b","name":"Register Webhook Local","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"callback\": \"www.somedomain.com/callback_url\",\n\t\"event\": \"product_create\"\n}"},"url":"https://integration.forstok.com/api/v2/channel/1/webhook/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 09:14:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"130"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"38abd122bddca8bd4771aed9a24912b3\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"d9540738-c944-4d9f-b140-333084ddff1c"},{"key":"X-Runtime","value":"0.366968"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"event\": \"product_create\",\n \"callback_url\": \"www.somedomain.com/callback_url\"\n },\n \"msg\": \"Success create webhook.\"\n}"}],"_postman_id":"56d42b21-4b70-4652-b700-95500ab7761e"},{"name":"Get Webhook List","id":"fd97c1f1-08e6-425e-ae26-9f6b2e09a591","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/webhook/list","description":"Parameter request
\n
To check the registered callback url that will receive the notifications from Forstok
\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","webhook","list"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"8074dc22-109f-491d-94f4-2c82f3943434","name":"Get Webhook List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://integration.forstok.com/api/v2/channel/1/webhook/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 09:16:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"323"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"c06f048008b640134f37d0dc3a2bcfc8\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"35421479-2f00-405a-a45c-afd7d6641feb"},{"key":"X-Runtime","value":"0.034950"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"product_create\": \"www.somedomain.com/callback_url\"\n },\n {\n \"product_update_attributes\": \"www.somedomain.com/callback_url1\"\n },\n {\n \"product_update_stock\": \"www.somedomain.com/callback_url2\"\n },\n {\n \"product_update_price\": \"www.somedomain.com/callback_url3\"\n },\n {\n \"product_update_status\": \"www.somedomain.com/callback_url4\"\n }\n ]\n}"},{"id":"85175583-be22-4e7c-93ee-ca609498cbd5","name":"Get Webhook List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://integration.forstok.com/api/v2/channel/1/webhook/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 09:16:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"323"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"c06f048008b640134f37d0dc3a2bcfc8\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"35421479-2f00-405a-a45c-afd7d6641feb"},{"key":"X-Runtime","value":"0.034950"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"product_create\": \"www.somedomain.com/callback_url\"\n },\n {\n \"product_update_attributes\": \"www.somedomain.com/callback_url1\"\n },\n {\n \"product_update_stock\": \"www.somedomain.com/callback_url2\"\n },\n {\n \"product_update_price\": \"www.somedomain.com/callback_url3\"\n },\n {\n \"product_update_status\": \"www.somedomain.com/callback_url4\"\n }\n ]\n}"}],"_postman_id":"fd97c1f1-08e6-425e-ae26-9f6b2e09a591"},{"name":"Register Email Notification [COMING SOON]","id":"64a74ae1-c259-484c-b197-ce9a3a8b2a40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"webhook_email\" : \"someone@mail.com\"\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/webhook/register_email_notification","description":"When a webhook call fails, the Forstok system will retry several times before it is marked as failed. All failed webhook calls and its payload will be delivered to the channel via email registered to this end point.
\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","webhook","register_email_notification"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"64a74ae1-c259-484c-b197-ce9a3a8b2a40"},{"name":"View Logs","id":"ec555e26-a8da-41ea-aab0-b7fe21080be1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"file","file":{}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/webhook/logs?from=2024-11-22&to=2024-11-22&event=product_create","description":"To get a log of triggered webhook calls.
\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","webhook","logs"],"host":["integration","forstok","com"],"query":[{"key":"from","value":"2024-11-22"},{"key":"to","value":"2024-11-22"},{"key":"event","value":"product_create"}],"variable":[]}},"response":[{"id":"e7af9166-b475-414a-a9bd-85e3cddd3010","name":"View Logs","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"file","file":{}},"url":{"raw":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/webhook/logs?from=2024-01-17&to=2024-01-17&event=product_create","protocol":"https","host":["integration","forstok","com"],"path":["api","v2","channel","{{channel_id}}","webhook","logs"],"query":[{"key":"from","value":"2024-01-17"},{"key":"to","value":"2024-01-17"},{"key":"event","value":"product_create"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 17 Jan 2024 04:03:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"ETag","value":"W/\"6503e8a9af4907237c63580ef9bd53d5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1a9f869f-98e8-4d24-8051-a764741c8252"},{"key":"X-Runtime","value":"0.018960"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": [\n {\n \"id\": 99822453,\n \"event\": \"product_create\",\n \"created_at\": \"2024-01-17T09:30:46.000+07:00\",\n \"response_status\": 200,\n \"response_body\": \"\\n\\n\\n \\n \\nEvent : When Users create a new product in Forstok, this payload will be sent to the registered url callback.
\nResponse
This Webhook receives a response to set a link to the live item url. In the response body of your endpoint, you can add “live_url” data. This live url will be set to the related variant in forstok system, so that every integrated seller will be able to open the display page of the channel directly from our system.
{\n “status” : “OK”, // you can add another response for your own needs\n “live_url” : [ // forstok will only process this response\n {\n \"variant_id\" : 123, \n \"url\" : \"\\\"https://abc.com/linktodiplayitemurl\\\"\"\n },\n {...}]\n}\n\nExample
\nSingle Variant Item :
\n{\n \"id\": 18029376,\n \"account_id\": 7457,\n \"name\": \"Single item webhook\",\n \"description\": \"cek webhook single item\",\n \"brand_name\": \"NoBrand\",\n \"variants\": [\n {\n \"id\": 18983166,\n \"account_id\": 7457,\n \"sku\": \"webhook1\",\n \"name\": \"Single item webhook\",\n \"barcode\": null,\n \"options\": [],\n \"status\": \"active\",\n \"weight\": 1,\n \"length\": 1,\n \"width\": 1,\n \"height\": 1,\n \"img_urls\": [\n \"https://d3ndwuuxpr6t02.cloudfront.net/system/item/images/images/136/004/646/xlarge/db1cc43f13c5466ff1c50f86857fb336.jpg?1660020295\"\n ],\n \"description\": \"cek webhook single item\",\n \"created_at\": \"2022-08-09T11:44:57.000+07:00\",\n \"updated_at\": \"2022-08-09T11:44:57.000+07:00\",\n \"price\": 10000,\n \"sale_price\": null,\n \"sale_start_at\": null,\n \"sale_end_at\": null,\n \"quantity\": 12,\n \"warehouses\": [\n {\n \"quantity\": 12,\n \"warehouse_id\": 1294,\n \"warehouse_code\": null\n }\n ]\n }\n ],\n \"forstok_category_id\": null,\n \"forstok_category_name\": null\n}\n\nMultivariant Item :
\n{\n \"id\": 18070164,\n \"account_id\": 7457,\n \"name\": \"Multivariant item webhook\",\n \"description\": \"Deskripsi Multivariant item webhook create product\",\n \"brand_name\": \"NoBrand\",\n \"variants\": [\n {\n \"id\": 19013348,\n \"account_id\": 7457,\n \"sku\": \"multi01\",\n \"name\": \"Multivariant item webhook\",\n \"barcode\": null,\n \"options\": [\n {\n \"Color\": \"Black\"\n }\n ],\n \"status\": \"active\",\n \"weight\": 2,\n \"length\": 2,\n \"width\": 2,\n \"height\": 2,\n \"img_urls\": [\n \"https://d3ndwuuxpr6t02.cloudfront.net/system/item/images/images/136/159/137/xlarge/237e76fe4606e836cd3c9ed74e59993e.jpg?1660032694\"\n ],\n \"description\": \"Deskripsi Multivariant item webhook create product\",\n \"created_at\": \"2022-08-09T15:11:39.000+07:00\",\n \"updated_at\": \"2022-08-09T15:11:39.000+07:00\",\n \"price\": 100000,\n \"sale_price\": null,\n \"sale_start_at\": null,\n \"sale_end_at\": null,\n \"quantity\": 2,\n \"warehouses\": [\n {\n \"quantity\": 2,\n \"warehouse_id\": 1294,\n \"warehouse_code\": null\n }\n ]\n },\n {\n \"id\": 19013349,\n \"account_id\": 7457,\n \"sku\": \"multi02\",\n \"name\": \"Multivariant item webhook\",\n \"barcode\": null,\n \"options\": [\n {\n \"Color\": \"Blue\"\n }\n ],\n \"status\": \"active\",\n \"weight\": 2,\n \"length\": 2,\n \"width\": 2,\n \"height\": 2,\n \"img_urls\": [\n \"https://d3ndwuuxpr6t02.cloudfront.net/system/item/images/images/136/159/138/xlarge/73cae54d5dbe763b5a71ceb66cdcbaff.jpg?1660032696\"\n ],\n \"description\": \"Deskripsi Multivariant item webhook create product\",\n \"created_at\": \"2022-08-09T15:11:39.000+07:00\",\n \"updated_at\": \"2022-08-09T15:11:39.000+07:00\",\n \"price\": 100000,\n \"sale_price\": null,\n \"sale_start_at\": null,\n \"sale_end_at\": null,\n \"quantity\": 2,\n \"warehouses\": [\n {\n \"quantity\": 2,\n \"warehouse_id\": 1294,\n \"warehouse_code\": null\n }\n ]\n }\n ],\n \"forstok_category_id\": null,\n \"forstok_category_name\": null\n}\n\nEvent : When Users update product attributes in Forstok, this payload will be sent to registered url callback.
\n\n{\n “id” : 456,\n “account_id” : 987234,\n \"name\": \"Baju Doraemon\",\n \"description\": \"Baju gambar Doraemon\",\n \"brand_name\": \"Doraemon\",\n \"forstok_category_id\": \"84138\",\n \"variants\": [\n {\n “id” : 123456,\n \"name\": \"Baju Doraemon size S\",\n \"location_id\" : \"\"\n \"description\": \"Itemnya baju Doraemon tapi yg ini ukuran S dengan ukuran 60 x 45 cm\",\n \"sku\": \"dora-s\",\n \"barcode\": \"dora12345\",\n \"weight\": 1,\n \"length\": 1\n \"height\": 1,\n \"width\": 1,\n \"options\": [ {\"size\": \"S\"}, {\"color\": \"Blue\"} ]\n },\n {\n “id” : 234567,\n \"name\": \"Baju Doraemon size M\",\n \"location_id\" : \"\"\n \"description\": \"Itemnya baju Doraemon tapi yg ini ukuran M dengan ukuran 65 x 50 cm\",\n \"sku\": \"dora-m\",\n \"barcode\": \"dora12346\",\n \"weight\": 1,\n \"length\": 1\n \"height\": 1,\n \"width\": 1,\n \"options\": [ {\"size\": \"M\"}, {\"color\": \"Blue\"} ]\n }]\n}\nEvent : When Users update stock in Forstok, this payload will be sent to registered url callback.
\nExample
\n\n{\n “account_id” : 987234,\n “id” : 253,\n “sku” : “IPH-3123”,\n “quantity” : 2 \n}\nEvent : When Users update price in forstok, this payload will be sent to the registered url callback.
\nExample
\n\n{\n “account_id” : 987234,\n “id” : 253,\n “sku” : “IPH-3123”,\n “price” : 2225000,\n “sale_price” : 8500000,\n “sale_start_at” : “2019-07-20T15:33:20.000+07:00”,\n “sale_end_at” : “2019-08-20T15:33:20.000+07:00”\n}\nEvent : When User updates status as product availability in Forstok, this payload will be sent to the registered url callback.
\n\n{\n “account_id” : 987234,\n “id” : 253,\n “sku” : “IPH-3123”,\n “status” : ”active” \n}\nEvent : When User unlist a product in Forstok, this payload will be sent to the registered url callback.
\nExample
\n\n{\n “account_id” : 987234,\n “id” : 253,\n “sku” : “IPH-3123”\n}\nEvent : When return was created in one order, this payload will be trigger with following structure.
\nExample
\n\n{\n \"account_id\": 6532,\n \"id\": 108817761,\n \"local_id\": \"T3JkZXI6NDIw\",\n \"item_lines\": [\n {\n \"variant_id\": null,\n \"sku\": \"8992696521261\",\n \"listing_id\": null,\n \"return_details\": {\n \"return_id\": 207,\n \"status\":\"closed\",\n \"reference\":\"\",\n \"courier\":\"\",\n \"awb\":\"\",\n \"notes\":\"\",\n \"refunded_amount\":\"\",\n \"return_reason\":\"Barang rusak\",\n \"qty_ordered\": 13,\n \"qty_returned\": 1,\n \"qty_restock\": 0,\n \"qty_received\": 0,\n \"returned_date\":\"2021-07-13T13:16:07.000+07:00\",\n \"created_at\": \"2021-07-13T13:16:07.000+07:00\",\n \"updated_at\": \"2021-07-13T13:16:07.000+07:00\"\n }\n }\n ]\n}\nEvent : When there is a change in payment status, this payload will be sent to the registered url callback.
\nExample
\n\n{\n “account_id” : 987234,\n “id” : 253,\n “local_id” : ”active”,\n “payment_status” : “1”,\n “payment_description” : “Pending”,\n “payment_method” : “cash”,\n “paid_at” : “2019-07-20T15:33:20.000+07:00”\n}\nEvent : When there is a change in fulfillment status, this payload will be sent to the registered url callback.
\nExample Status Ready to Ship
\n{\n “account_id” : 987234,\n “id” : 253,\n “local_id” : ”SO-0001”,\n “item_lines” : [\n {\n \"variant_id\" : 234,\n \"listing_id\":445,\n “sku” : “ITM-123”,\n “fulfillment_status” : 4,\n “fulfillment_description” : Ready to Ship,\n “courier” : “JNE”,\n “awb” : “982634127”,\n “shipped_at” : “2019-07-20T15:33:20.000+07:00”\n },\n { . . . }]\n}\n\nExample Status Cancelled
\n{\n \"account_id\": 1234,\n \"id\": 1008980,\n \"local_id\": \"INV/2020/11/0000010\",\n \"item_lines\": [\n {\n \"variant_id\": 14600778,\n \"listing_id\": 13697954,\n \"sku\" : \"ITM-123\",\n \"fulfillment_status\": 3,\n \"fulfillment_description\": \"Cancelled\",\n \"cancelled_quantity\": 1,\n \"cancelled_at\": \"2020-11-20T11:17:35.000+07:00\"\n }\n ]\n}\n\nTo get list of accounts that have activated the channel
\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","get_account_list"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b00e1e68-497e-4f7c-95cd-4229700a74a4"}],"id":"9c96b11d-3acf-4d51-ba8b-342a2227055f","_postman_id":"9c96b11d-3acf-4d51-ba8b-342a2227055f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API to create new order
\n\n\nUpdate Log
\n
\n\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","order","create"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"2d8cbf43-25c7-4965-896c-6e650f6fab0e","name":"Multiwarehouse Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 7457,\n \"order\": {\n \"local_id\":\"testingmwh1\",\n \"invoice_number\": \"1/INV/14/IV/2021\",\n \"ordered_at\":\"2023-02-14 11:49:18\",\n \"shipping_price\": 9000,\n \"shipping_provider\": \"Jalur Nugraha Ekakurir (JNE)\",\n \"voucher_code\": \"\",\n \"voucher_amount\": 0,\n \"discount_reason\": \"\",\n \"discount_amount\": 0,\n \"disc_shipping_seller\": 12000,\n \"tax_amount\": 828,\n \"note\":\"isi note bebas disini\",\n \"internal_note\":\"isi internal note bebas disini\",\n \"warehouse_code\" : \"123\", //you can also use \"warehouse_id\"\n \"address\":{\n \"name\":\"Amin Musaik\",\n \"phone\":\"7777777777\",\n \"email\":\"youremail@address.com\",\n \"address_1\":\"JL. Cenderawasih, komplek rajawali, belakang kahyuna cafe, samping tower telkomselDKI jakarta, jakarta timurKelurahan : Halim perdana kusumaKecamatan : makasar\",\n \"address_2\":\"\",\n \"sub_district\": \"HALIM PERDANA KUSUMAH\",\n \"district\": \"MAKASAR\",\n \"city\":\"KOTA JAKARTA TIMUR\",\n \"province\":\"DKI Jakarta\",\n \"country\":\"Indonesia\",\n \"postal_code\":\"13610\"\n },\n \"item_lines\":[\n {\n \"local_id\":\"singleitem1520\",\n \"variant_id\":\"20406738\",\n \"sku\":\"skusingleitem1520\",\n \"name\":\"logitech-m590-red\",\n \"price\":699000,\n \"sale_price\":595000, // input \"sale_price\": null, if no sale_price\n \"voucher_amount\": 104000, // input \"voucher_amount\": null, if no voucher_amount\n \"quantity\":1,\n \"note\":\"isi note bebas disini\",\n \"internal_note\":\"isi internal note bebas disini\"\n }\n ],\n \"payment\":{\n \"status_payment\":1,\n \"payment_method\": \"TRANSFER\"\n }\n}\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 14 Feb 2023 07:48:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"ETag","value":"W/\"9e96d804291dcfc8e0183264027b7895\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1df96c87-5116-448f-9bf8-988850d426d0"},{"key":"X-Runtime","value":"0.082931"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"local_id\": \"testingmwh1\",\n \"id\": 129279302\n }\n}"},{"id":"2a6819c5-a42f-4f5e-99de-16342b13c32b","name":"Create Order Success Sample","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 6532,\n \"order\": {\n \"local_id\":\"4-abcdefg\",\n \"invoice_number\": \"4/INV/16/IV/2021\",\n \"ordered_at\":\"2021-04-16 09:45:18\",\n \"shipping_price\": 9000,\n \"shipping_provider\": \"Jalur Nugraha Ekakurir (JNE)\",\n \"discount_reason\": \"\",\n \"discount_amount\": 0,\n \"rebate\": 828,\n \"address\":{\n \"name\":\"Amin Musaik\",\n \"phone\":\"7777777777\",\n \"address_1\":\"JL. Cenderawasih, komplek rajawali, belakang kahyuna cafe, samping tower telkomselDKI jakarta, jakarta timurKelurahan : Halim perdana kusumaKecamatan : makasar\",\n \"address_2\":\"\",\n \"sub_district\": \"HALIM PERDANA KUSUMAH\",\n \"district\": \"MAKASAR\",\n \"city\":\"KOTA JAKARTA TIMUR\",\n \"province\":\"DKI Jakarta\",\n \"country\":\"Indonesia\",\n \"postal_code\":\"13610\"\n },\n \"item_lines\":[\n {\n \"local_id\":\"variant_local_id_01\",\n \"variant_id\":\"15458168\",\n \"sku\":\"logitech-m590-red\",\n \"name\":\"logitech-m590-red\",\n \"price\":699000,\n \"sale_price\":595000,\n \"voucher_seller\": 1000,\n \"quantity\":1\n },\n {\n \"local_id\":\"15406529\",\n \"variant_id\":\"15406529\",\n \"sku\":\"dora-s-3\",\n \"name\":\"Baju Doraemon size S - S/Blue\",\n \"price\":50000,\n \"sale_price\":10000,\n \"voucher_seller\": 1000,\n \"quantity\":1\n }\n ],\n \"payment\":{\n \"status_payment\":1,\n \"payment_method\": \"TRANSFER\"\n }\n}\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Apr 2021 02:45:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"af011b508c1688ac96c67e14cf8d533c\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"de802fd0-a555-4277-8f9a-3b8021f76959"},{"key":"X-Runtime","value":"0.055470"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"local_id\": \"4-abcdefg\",\n \"id\": 105682437\n }\n}"},{"id":"66167d79-478b-4d5c-b916-70fa6439031c","name":"Create Order sample 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 5984,\n \"order\": {\n \"address\": {\n \"address_1\": \"Jalan timur tenggara selatan barat daya 1 gang 2\",\n \"address_2\": \"sebrang toko firman\",\n \"city\": \"Jakarta Utara\",\n \"country\": \"Indonesia\",\n \"name\": \"Adi Perkasa\",\n \"phone\": \"622622788\",\n \"postal_code\": \"11250\",\n \"province\": \"DKI Jakarta\"\n },\n \"item_lines\": [\n {\n \"local_id\": 23,\n \"name\": \"ipad standing - Small\",\n \"price\": 125000,\n \"quantity\": 1,\n \"sku\": \"123\",\n \"variant_id\": 12226086\n }\n ],\n \"local_id\": \"1000-001\",\n \"ordered_at\": \"2020-10-13T06:11:20.000000Z\",\n \"payment\": {\n \"paid_at\": \"2020-10-13T06:11:20.000000Z\",\n \"payment_method\": \"Virtual Bank\",\n \"status_payment\": 1\n },\n \"shipping_price\": 9000,\n \"shipping_provider\": \"Ongkos Kirim Ekonomis (OKE): 3-6 days after shipment\"\n }\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Oct 2020 08:56:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"731845fb019d309b5dc8502e197045dd\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"4be4878c-7d90-49c8-bd90-44505ae6a543"},{"key":"X-Runtime","value":"0.059010"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"local_id\": \"1000-001\",\n \"id\": 99921569\n }\n}"},{"id":"a8c804d3-9e44-4a97-902a-3ca543728f00","name":"Sample 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 6532,\n \"order\": {\n \"address\":{\n \"address_1\":\"Jl. Gn. Sahari No.1, Ancol, Kec. Pademangan, Kota Jkt Utara, Daerah Khusus Ibukota Jakarta 14420\",\n \"address_2\":\"\",\n \"city\":\"Jakarta Utara\",\n \"country\":\"Indonesia\",\n \"name\":\"Sualeman Wirawan\",\n \"phone\":\"7777777777\",\n \"postal_code\":\"77777\",\n \"province\":\"DKI Jakarta\",\n \"coordinate\":\"-6.138549414586765, 106.83234579956027\"\n },\n \"item_lines\":[\n {\n \"variant_id\":15458168,\n \"local_id\":\"variant_local_id_01\",\n \"name\":\"Mouse Logitech m590 Multi Devices\",\n \"price\":595000,\n \"quantity\":1,\n \"sku\":\"logitech-m590-red\"\n }\n ],\n \"local_id\":\"20210408-001\",\n \"ordered_at\":\"2021-04-08 07:18:05\",\n \"payment\":{\n \"status_payment\":1\n },\n \"shipping_price\":45000,\n \"shipping_provider\":\"Sameday Delivery\"\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Apr 2021 07:22:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"1ad20ab17277a3d0ce5727d0cbe31738\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"450b0717-5104-4ab2-b879-64a051bc3baa"},{"key":"X-Runtime","value":"0.066702"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"local_id\": \"20210408-001\",\n \"id\": 105427353\n }\n}"},{"id":"9ddede13-a18d-4078-8306-57198a490504","name":"Sale Price","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_id\": 6532,\n \"order\": {\n \"local_id\":\"b40451d7-7968-434d-a2a1-e147fcb576db\",\n \"invoice_number\": \"2096/INV/14/IV/2021\",\n \"ordered_at\":\"2021-04-14 10:49:18\",\n \"shipping_price\": 9000,\n \"shipping_provider\": \"Jalur Nugraha Ekakurir (JNE)\",\n \"voucher_code\": \"\",\n \"voucher_amount\": 0,\n \"discount_reason\": \"\",\n \"discount_amount\": 0,\n \"tax_amount\": 828,\n \"address\":{\n \"name\":\"Amin Musaik\",\n \"phone\":\"7777777777\",\n \"address_1\":\"JL. Cenderawasih, komplek rajawali, belakang kahyuna cafe, samping tower telkomselDKI jakarta, jakarta timurKelurahan : Halim perdana kusumaKecamatan : makasar\",\n \"address_2\":\"\",\n \"sub_district\": \"HALIM PERDANA KUSUMAH\",\n \"district\": \"MAKASAR\",\n \"city\":\"KOTA JAKARTA TIMUR\",\n \"province\":\"DKI Jakarta\",\n \"country\":\"Indonesia\",\n \"postal_code\":\"13610\"\n },\n \"item_lines\":[\n {\n \"local_id\":\"variant_local_id_01\",\n \"variant_id\":\"15458168\",\n \"sku\":\"logitech-m590-red\",\n \"name\":\"logitech-m590-red\",\n \"price\":699000,\n \"sale_price\":595000,\n \"quantity\":1\n },\n {\n \"local_id\":\"15406529\",\n \"variant_id\":\"15406529\",\n \"sku\":\"dora-s-3\",\n \"name\":\"Baju Doraemon size S - S/Blue\",\n \"price\":50000,\n \"sale_price\":10000,\n \"quantity\":1\n }\n ],\n \"payment\":{\n \"status_payment\":1,\n \"payment_method\": \"TRANSFER\"\n }\n}\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 Apr 2021 06:30:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"89"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"adfda6381af5853caa55c3047a2a1b18\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"1ff7a7b3-b3dd-4d58-88b1-76df9486cd7e"},{"key":"X-Runtime","value":"0.086574"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"data\": {\n \"local_id\": \"b40451d7-7968-434d-a2a1-e147fcb576db\",\n \"id\": 105627467\n }\n}"}],"_postman_id":"63f5018c-cce1-451f-89ea-842051ae1629"},{"name":"Update Payment Status","id":"3c0c5c87-a470-452c-bb60-7f3327ac9407","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_id\" : 6532,\n\t\"id\" : 105135118,\n\t\"payment_status\" : 3,\n\t\"payment_description\" : \"Paid\",\n \"payment_method\":\"Snap Bank Transfer\",\n \"paid_at\" : \"2021-04-29T15:17:20.000+07:00\"\n}\n"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/status_payment_update","description":"Parameter request body
\n
Use this API to update Payment Status. You can choose either \"id\" as order id Forstok or \"local_id\" as order id Channel (Your system) to update Order.
\n\n\nPayment Status Info
\n
\n\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","order","status_payment_update"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"7c21c8cc-ddac-46e1-8285-f798aadf9424","name":"Paid Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_id\" : 5983,\n\t\"id\" : 100116048,\n\t\"local_id\" : \"1045023872-4\",\n\t\"payment_status\" : 3,\n \"payment_method\":\"Snap Bank Transfer\",\n\t\"payment_description\" : \"Paid\",\n\t\"paid_at\" : \"2020-20-23T15:33:20.000+07:00\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/status_payment_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Oct 2020 10:58:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Etag","value":"W/\"3459a9ea598b1dd1d2ad2d8d394fdb9a\""},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"e9f32476-f879-4fcc-a628-1de43d336c03"},{"key":"X-Runtime","value":"0.033050"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"message\": \"Success Update Payment Order.\"\n}"},{"id":"3332eede-9638-4959-9df8-2c4958976c04","name":"Unpaid Orders","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_id\" : 6532,\n\t\"id\" : 108562006,\n\t\"payment_status\" : 4,\n\t\"payment_description\" : \"Cancelled\",\n \"payment_method\":\"Card\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/status_payment_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Jun 2021 04:29:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"ETag","value":"W/\"3459a9ea598b1dd1d2ad2d8d394fdb9a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"73e99850-0f3a-47d0-a661-778c1c461445"},{"key":"X-Runtime","value":"0.078693"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"message\": \"Success Update Payment Order.\"\n}"}],"_postman_id":"3c0c5c87-a470-452c-bb60-7f3327ac9407"},{"name":"Update Fulfillment Status","id":"98d1bfca-28f8-4cd0-8c73-b2f64be72dd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"account_id\" : 6533,\r\n\t\"id\" : 105803861,\r\n \"fulfillment_status_id\": 4,\r\n \"courier\":\"Jalur Nugraha Ekakurir (JNE)\",\r\n \"awb\":\"3456789078\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/status_fulfillment_update","description":"Parameter request body
\n
Use this API to update Fulfillment Status. This API only works for Orders with status Open or Payment status = Paid.
\n\n\nFulfillment Status ID
\n
\n\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","order","status_fulfillment_update"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"ca1cd284-c7c6-46ff-833c-cb73839949f7","name":"Success Update All","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"account_id\" : 6533,\r\n\t\"id\" : 105803861,\r\n \"fulfillment_status_id\": 4, //2=Delivered, 4=Ready to Ship\r\n \"courier\":\"Jalur Nugraha Ekakurir (JNE)\",\r\n \"awb\":\"3456789078\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/order/status_fulfillment_update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 03:16:08 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"X-Request-Id","value":"13d43232-d996-4a12-b9e2-bf2bd94eebac"},{"key":"X-Runtime","value":"3.262449"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"message\": \"Success Update Fulfillment status.\"\n}"}],"_postman_id":"98d1bfca-28f8-4cd0-8c73-b2f64be72dd2"}],"id":"6db2bb1c-e330-4544-8683-8fd966082863","description":"Parameter request body
\n
Forstok Master Courier: https://docs.google.com/spreadsheets/d/1rbTrvEd2yc91EEBMz_jA4G5DDc84jZ0zcie5Hx6Sv64/edit?usp=sharing
\n","_postman_id":"6db2bb1c-e330-4544-8683-8fd966082863","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API to Create Product Listing.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Notes: Images url's need to be real and accessible.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API to create a product in Forstok system.
\n","urlObject":{"protocol":"https","path":["api","v2","channel","{{channel_id}}","product","update_qc_status"],"host":["integration","forstok","com"],"query":[],"variable":[]}},"response":[{"id":"e9bd2596-6ab3-4888-b2cd-6bbfb5feb0ee","name":"Success and Failed in one request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"products\": [\r\n {\r\n \"product_id\": \"16524253\", //success and will still be sent to forstok\r\n \"status\": \"1\"\r\n },\r\n {\r\n \"product_id\": \"5897240\", //failed (wrong product_id) and will not be sent to forstok\r\n \"status\": \"1\"\r\n }\r\n ]\r\n}"},"url":"https://integration.forstok.com/api/v2/channel/{{channel_id}}/product/update_qc_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 Jun 2022 08:39:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"ETag","value":"W/\"74bb7f63721e480dae73d96f328ee4ac\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"dceb6574-c51d-4db4-a267-39348c6dc22f"},{"key":"X-Runtime","value":"0.093638"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"message\": \"\",\n \"failed_data\": [\n {\n \"product_id\": \"5897240\",\n \"status\": \"1\"\n }\n ]\n}"}],"_postman_id":"89cbbedf-448a-4746-b048-c56012f0afa6"}],"id":"aec53142-8e8e-4894-ac85-7f182d658e9c","_postman_id":"aec53142-8e8e-4894-ac85-7f182d658e9c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"