Getting Started Edit
Welcome to the Getting Started guide for Prosperna API Documentation!
Prosperna is an all-in-one eCommerce platform for Philippine businesses. We are on a mission to empower 100,000 Philippine MSMEs with simple and affordable eCommerce software. In fact, we are super passionate about helping Philippine MSMEs we’re giving you a free account forever!
You’ll succeed if you do this.
Here’s some useful information.
Something may not happen if you try and do this.
Something bad will happen if you do this.
Authentication Edit
You need to be authenticated for all API requests. You can generate an API key in your developer dashboard.
Add the API key to all requests as a GET parameter.
Nothing will work unless you include this API key
$.get("http://api.myapp.com/orders/", { "token": "YOUR_APP_KEY"}, function(data) {
alert(data);
});
curl http://api.myapp.com/orders?token=YOUR_APP_KEY
Errors Edit
| Code | Name | Description |
|---|---|---|
| 200 | OK | Success |
| 201 | Created | Creation Successful |
| 400 | Bad Request | We could not process that action |
| 403 | Forbidden | We couldn’t authenticate you |
All errors will return JSON in the following format:
{
"error": true,
"message": "error message here"
}
/merchant-listing Edit
Get all Products
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/products/merchant-listing',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"products": [
{
"product_specification": {
"name": "product_name",
"slug": "unique_product_slug",
"brand": "product_brand",
"short_description": "short_description",
"long_description": "<p><strong>long_description</strong></p>",
"images": [
{
"image": "image_uri",
"original_name": "original_name",
"type": "images/png",
"name_with_path": "name_with_path",
"id": "image_id"
}
]
},
"product_state": {
"is_product_has_variants": false,
"is_hide_stock": true,
"is_always_instock": true,
"is_published": true
},
"product_seo": {
"primary": {
"title": "seo_title",
"description": "seo description",
"url": "url"
}
},
"product_measurements": {
"product_size": {
"height": 44,
"length": 74,
"width": 45,
"unit": "cm"
},
"product_weight": {
"weight": 55,
"unit": "lb"
}
},
"product_price": {
"regular_price": 28,
"sale_price": 0,
"price_display": "",
"unit_cost": 0,
"margin": 0,
"stock_quantity": 19
},
"product_categories": [
{
"name": "category_name",
"id": "category_id"
}
],
"createdAt": "2023-02-12T14:29:12.173Z",
"updatedAt": "2023-03-01T10:14:31.171Z",
"product_type": "PHYSICAL",
"id": "63e8f7b8c07f74725ccd2fb2",
"store_id": "639749a5cb1db88617891bf0",
"product_variant_types": [
{
"id": "63e5810a763ae9c5f788b2e5",
"product_id": "63e4f4fabf61b3a5047d9da4",
"name": "Color",
"with_color_variant": true,
"variant_type_options": [
{
"name": "White",
"color": "#fff",
"id": "63e5810a763ae9c5f788b2e6"
},
{
"name": "Black",
"color": "#000",
"id": "63e5810a763ae9c5f788b2e7"
}
],
"createdAt": "2023-02-09T23:26:02.164Z",
"updatedAt": "2023-02-09T23:26:02.164Z"
},
{
"id": "63e5820f763ae9c5f788b2eb",
"product_id": "63e4f4fabf61b3a5047d9da4",
"name": "Flavor",
"with_color_variant": false,
"variant_type_options": [
{
"name": "variant_type_option_name",
"color": "",
"id": "variant_type_option_id"
}
],
"createdAt": "2023-02-10T13:40:04.358Z",
"updatedAt": "2023-02-10T13:40:04.358Z"
}
],
"product_variants_combinations": [
{
"name": "variant_combination_name",
"price": 12.3,
"stock_quantity": 10,
"sale_price": 0,
"margin": 0,
"sku": "",
"createdAt": "2023-02-03T01:31:06.493Z",
"updatedAt": "2023-02-03T01:31:06.493Z",
"id": "63dc63dae6ea5a06a9801d8b",
"product_id": null,
"variant_combination_image": {
"image": "image_uri",
"original_name": "original_name",
"type": "images/png",
"name_with_path": "name_with_path"
},
"variant_combinations": [
{
"selected_variant_option_id": "selected_variant_option_id",
"variant_type_id": "variant_type_id"
},
{
"selected_variant_option_id": "selected_variant_option_id",
"variant_type_id": "variant_type_id"
}
]
}
]
}
],
"pagination": {
"totalDocs": 1,
"limit": 999999,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}
},
"message": "",
"statusCode": 200
}
{
"error": true,
"message": "Invalid score"
}
/:product_id Edit
Get single product
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| product_id | string | Yes | Product id |
var axios = require('axios');
var data = '';
var config = {
method: 'get',
url: 'api.prosperna.com/v1/products/:product_id'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"product_specification": {
"name": "product_name",
"slug": "product_slug",
"brand": "product_brand",
"short_description": "short description",
"long_description": "<p>long description</p>",
"images": [
{
"image": "image_uri",
"original_name": "original_name",
"type": "images/png",
"name_with_path": "name_with_path",
"id": "image_id"
}
]
},
"product_state": {
"is_product_has_variants": false,
"is_hide_stock": true,
"is_always_instock": true,
"is_published": true
},
"product_measurements": {
"product_size": {
"height": 100,
"length": 62,
"width": 1235,
"unit": "cm"
},
"product_weight": {
"weight": 45,
"unit": "l"
}
},
"product_price": {
"regular_price": 900,
"sale_price": 12,
"price_display": "",
"unit_cost": 56,
"margin": 0,
"stock_quantity": 0
},
"product_seo": {
"primary": {
"title": "seo_title",
"description": "seo description",
"url": "url"
}
},
"product_addons": {
"addOn_limit": 1,
"addOn_list": [
{
"name": "addon_name",
"price": 55.55,
"description": "Addon description",
"createdAt": "2023-02-09T13:38:21.140Z",
"updatedAt": "2023-02-09T13:38:21.140Z",
"store_id": "639749a5cb1db88617891bf0",
"id": "63e4f74dbf61b3a5047d9dbe"
}
]
},
"product_categories": [
{
"name": "category_name",
"id": "63e4f6c4bf61b3a5047d9daf"
}
],
"product_variant_types": [
{
"id": "63e5810a763ae9c5f788b2e5",
"product_id": "63e4f4fabf61b3a5047d9da4",
"name": "Color",
"with_color_variant": true,
"variant_type_options": [
{
"name": "White",
"color": "#fff",
"id": "63e5810a763ae9c5f788b2e6"
},
{
"name": "Black",
"color": "#000",
"id": "63e5810a763ae9c5f788b2e7"
}
],
"createdAt": "2023-02-09T23:26:02.164Z",
"updatedAt": "2023-02-09T23:26:02.164Z"
},
{
"id": "63e5820f763ae9c5f788b2eb",
"product_id": "63e4f4fabf61b3a5047d9da4",
"name": "Flavor",
"with_color_variant": false,
"variant_type_options": [
{
"name": "variant_type_option_name",
"color": "",
"id": "variant_type_option_id"
}
],
"createdAt": "2023-02-10T13:40:04.358Z",
"updatedAt": "2023-02-10T13:40:04.358Z"
}
],
"createdAt": "2023-02-09T13:28:26.326Z",
"updatedAt": "2023-02-18T06:11:04.116Z",
"product_type": "PHYSICAL",
"id": "63e4f4fabf61b3a5047d9da4",
"store_id": "639749a5cb1db88617891bf0",
"product_variants_combinations": [
{
"name": "variant_combination_name",
"price": 12.3,
"stock_quantity": 10,
"sale_price": 0,
"margin": 0,
"sku": "",
"createdAt": "2023-02-03T01:31:06.493Z",
"updatedAt": "2023-02-03T01:31:06.493Z",
"id": "63dc63dae6ea5a06a9801d8b",
"product_id": null,
"variant_combination_image": {
"image": "image_uri",
"original_name": "original_name",
"type": "images/png",
"name_with_path": "name_with_path"
},
"variant_combinations": [
{
"selected_variant_option_id": "selected_variant_option_id",
"variant_type_id": "variant_type_id"
},
{
"selected_variant_option_id": "selected_variant_option_id",
"variant_type_id": "variant_type_id"
}
]
}
]
},
"message": "",
"statusCode": 200
}
{
"error": true,
"message": "Invalid score"
}
/pre-create Edit
Pre create product
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| product_type | string | Yes | Type of product either ‘physical’ or ‘digital’. |
var axios = require('axios');
var data = '';
var config = {
method: 'post',
url: 'api.prosperna.com/v1/products/pre-create?product_type=physical'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"id": "640da6e972daff1949be2a16",
"product_type": "physical"
},
"message": "Product pre created.",
"statusCode": 201
}
/:product_id Edit
Save/Update Product
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| product_id | string | Yes | Product id |
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| product_specification.name | string | Yes | Product name |
| product_specification.slug | string | Yes | Product slug (without url) |
| product_specification.short_description | string | Yes | Product short description |
| product_specification.long_description | string | Yes | Product long description |
| product_specification.brand | string | No | Product brand |
| product_specification.images | array | Yes | Product images/thumbnails. |
| product_state.is_always_instock | boolean | Yes | PAID FEATURE Boolean value for is always instock feature. |
| product_state.is_hide_stock | boolean | Yes | PAID FEATURE Boolean value for is always hiding stock. |
| product_state.is_product_has_variants | boolean | Yes | Boolean value to set if product has variants. |
| product_categories | array | Yes | Array of categories id for a given product. |
| product_variant_types | array | Yes, if is_product_has_variants is set to true else No. | Array of product variant types. |
| product_variants_combinations | array | Yes, if is_product_has_variants is set to true else No. | Array of variant combinations. |
| product_addons | object | No | PAID FEATURE Product addons, object containing the addon limit and array of addons ids. |
| product_price.regular_price | number | Yes, if is_product_has_variants is set to false else No. | Product regular price. |
| product_price.sale_price | number | No | Product regular price. |
| product_price.stock_quantity | number | Yes, if is_product_has_variants is set to false else No. | Product stock quantity. |
| product_price.margin | number | No | Product sale price. |
| product_price.unit_cost | number | No | Product sale price. |
| product_measurements.product_size.height | number | Yes, if is_product_has_variants is set to false else No. | Product height. |
| product_measurements.product_size.width | number | Yes, if is_product_has_variants is set to false else No. | Product width. |
| product_measurements.product_size.length | number | Yes, if is_product_has_variants is set to false else No. | Product length. |
| product_measurements.product_size.unit | string | Yes, if is_product_has_variants is set to false else No. | Product size unit. ['mm', 'cm', 'in', 'm'] |
| product_measurements.product_weight.weight | number | Yes, if is_product_has_variants is set to false else No. | Product weight. |
| product_measurements.product_weight.unit | string | Yes, if is_product_has_variants is set to false else No. | Product weight unit. ['g', 'kg', 'lb', 'ml', 'l', 'Oz'] |
| product_seo.primary.title | string | No | PAID FEATURE SEO title. |
| product_seo.primary.description | string | No | PAID FEATURE SEO description. |
| product_seo.primary.url | string | No | PAID FEATURE SEO url. |
var axios = require('axios');
var data = JSON.stringify({
product_specification: {
name: 'product_name',
slug: 'product_slug',
long_description: 'long description',
short_description: 'short description',
brand: 'product_brand',
images: [
{
image: 'base64 image',
file_name: 'image file name',
image_action: 'new', // "delete" | "new" | "ordering_update"
},
],
},
product_state: {
is_always_instock: true,
is_hide_stock: true,
is_product_has_variants: false,
},
product_price: {
regular_price: 900,
margin: 56,
sale_price: 12,
unit_cost: 56,
stock_quantity: 56,
},
product_measurements: {
product_size: {
height: 100,
width: 1235,
length: 62,
unit: 'cm',
},
product_weight: {
weight: 45,
unit: 'l',
},
},
product_variants_combinations: ['63e58292ad7a318363625be4'],
product_variant_types: [
'63e5810a763ae9c5f788b2e5',
'63e5820f763ae9c5f788b2eb',
],
product_addons: {
addOn_limit: 1,
addOn_list: ['63e4f74dbf61b3a5047d9dbe'],
},
product_categories: ['63e4f6c4bf61b3a5047d9daf'],
product_seo: {
primary: {
title: 'seo_title',
description: 'seo description',
url: 'http://localhost:3000',
},
},
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/products/640c8c4de596bf3e3684bb57',
headers: {
'Content-Type': 'application/json',
},
data: data,
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": null,
"message": "Successfully updated product.",
"statusCode": 200
}
/:product_id Edit
Delete single product
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| product_id | string | Yes | Product id |
var axios = require('axios');
var data = '';
var config = {
method: 'delete',
url: 'api.prosperna.com/v1/products/:product_id'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": null,
"message": "Successfully updated product.",
"statusCode": 200
}
/storage Edit
Storage breakdown for product usage
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/products/storage',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"total_consumed": {
"gb": 0,
"mb": 0.94
},
"store_allocation": {
"gb": 25,
"mb": 25600
},
"remaining_space": {
"gb": 25,
"mb": 25599.06
}
},
"message": "",
"statusCode": 200
}
/stock-quantity Edit
Decrease the product quantity and product variant combination quantity
| Request body | Data Type | Required | Description |
|---|---|---|---|
| array | Yes | Array of objects with the product id/variant combinationation id and the quantity that will be deducted. |
Example request body.
[
{
"product_id": "63e4f4fabf61b3a5047d9da4",
"purchased_quantity": 9
},
{
"purchased_quantity": 5,
"product_variant_combination_id": "63e64f99ca104a61440fd50b"
}
]
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Merchant store id |
var axios = require('axios');
var data = JSON.stringify([
{
"product_id": "63e4f4fabf61b3a5047d9da4",
"purchased_quantity": 9
},
{
"purchased_quantity": 5,
"product_variant_combination_id": "63e64f99ca104a61440fd50b"
}
]);
var config = {
method: 'post',
url: 'api.prosperna.com/v1/products/stock-quantity?store_id=639749a5cb1db88617891bf0',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": null,
"message": "Inventory successfully updated.",
"statusCode": 200
}
/status Edit
Publish or unpublish products, accepts array of product id
| Request body | Data Type | Required | Description |
|---|---|---|---|
| array | Yes | Array of product ids. |
Example request body.
["63e4f4fabf61b3a5047d9da4", "63e64f99ca104a61440fd50b"]
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| action | string | Yes | publish or unpublish |
var axios = require('axios');
var data = JSON.stringify([
"639584fdde9e74b0a80d1606"
]);
var config = {
method: 'post',
url: 'api.prosperna.com/v1/products/status?action=publish',
data: data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"publishedProducts": 10,
"storePlan": "PLUS",
"eligibleProductsToPublish": "40"
},
"message": "published",
"statusCode": 200
}
/ Edit
Create Order
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | ID of the Store |
| customer_id | string | Yes | ID of the Consumer |
| cart_id | string | Yes | ID of the Cart of Consumer |
| urls | object | Yes | Redirection URLs for Order API result. Possible values: { “success_redirect_url”: “https://www.google.com/search?q=success”, “failure_redirect_url”: “https://www.google.com/search?q=failed”, “cancel_redirect_url”: “https://www.google.com/search?q=cancel” } |
| order_information | object | Yes | Possible values: { “fname”: “Juan”, “lname”: “Dela Cruz”, “email_address”: “email@email.com”, “phone”: “639685432321”, “address_line”: “Star Building”, “state”: “METRO-MANILA”, “city”: “BINONDO”, “barangay”: “BARANGAY 287”, “zip_code”: “1234”, “note”: “” } |
| shipping_information | object | Yes | Possible values: { “type”: (Possible types: “STANDARD_JNT”, “OWN_BOOKING”, “PICKUP”, “SAMEDAY_SCHED_LALAMOVE”) } |
| dimensions | object | Yes | Dimensions of the Ordered Product. Possible values: { “actual_weight”: 12, “volumetric_weight”: 8.0905 } |
| payment_information | object | Yes | Possible values: { “type”: (Possible types: “EWALLET”, “OVER_THE_COUNTER”, “COP”, “COD”, “CREDIT_CARD”) } |
| fees | object | Yes | Possible values: { “convenience_fee”: 0, “convenience_fee_customer”: 0, “shipping_fee”: 0, “additional_fee”: 0 } |
var axios = require('axios');
var data = JSON.stringify({
"store_id": "637de5eab94b30555121f36c",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"cart_id": "640ebf13dc76cdcd5c0c0e03",
"urls": {
"success_redirect_url": "https://starcomputers.prodev.prosperna.ph/checkout/thank-you",
"failure_redirect_url": "https://starcomputers.prodev.prosperna.ph/products",
"cancel_redirect_url": "https://starcomputers.prodev.prosperna.ph/products"
},
"order_information": {
"fname": "TEST",
"lname": "ORDER",
"email_address": "ian+637de5eab94b30555121f36c@prosperna.com",
"phone": "639685432321",
"address_line": "sdasdasd",
"state": "METRO-MANILA",
"city": "BINONDO",
"barangay": "BARANGAY 287",
"zip_code": "sdasdasd",
"note": "PRO1-DISABLE-JNT-56770644-c14b-11ed-afa1-0242ac120002",
"quotation": {}
},
"shipping_information": {
"type": "STANDARD_JNT"
},
"dimensions": {
"actual_weight": 12,
"volumetric_weight": 8.0905
},
"payment_information": {
"type": "COD"
},
"fees": {
"convenience_fee": 0,
"convenience_fee_customer": 0,
"shipping_fee": 0,
"additional_fee": 0
}
});
var config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.prosperna.com/v1/orders/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"store_id": "637de5eab94b30555121f36c",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"cart_id": "640ebf13dc76cdcd5c0c0e03",
"urls": {
"success_redirect_url": "https://starcomputers.prodev.prosperna.ph/checkout/thank-you",
"failure_redirect_url": "https://starcomputers.prodev.prosperna.ph/products",
"cancel_redirect_url": "https://starcomputers.prodev.prosperna.ph/products"
},
"order_information": {
"fname": "TEST",
"lname": "ORDER",
"email_address": "ian+637de5eab94b30555121f36c@prosperna.com",
"phone": "639685432321",
"address_line": "sdasdasd",
"state": "METRO-MANILA",
"city": "BINONDO",
"barangay": "BARANGAY 287",
"zip_code": "sdasdasd",
"note": "PRO1-DISABLE-JNT-56770644-c14b-11ed-afa1-0242ac120002",
"quotation": {}
},
"shipping_information": {
"type": "STANDARD_JNT"
},
"dimensions": {
"actual_weight": 12,
"volumetric_weight": 8.0905
},
"payment_information": {
"type": "COD"
},
"fees": {
"convenience_fee": 0,
"convenience_fee_customer": 0,
"shipping_fee": 0,
"additional_fee": 0
}
}
{
"data": {
"order_id": "640fc92a2742e57a81038b08",
"store_id": "637de5eab94b30555121f36c",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"cart_ids": [
"640fc91d2742e57a81038b05"
],
"ordered_item_ids": [],
"is_trashed": false,
"order_total_amount": 1000,
"order_subtotal_amount": 1000,
"order_total_qty": 1,
"order_information": {
"fname": "TEST",
"lname": "ORDER",
"email_address": "ian+637de5eab94b30555121f36c@prosperna.com",
"phone": "639685432321",
"address_line": "sdasdasd",
"state": "METRO-MANILA",
"city": "BINONDO",
"barangay": "BARANGAY 287",
"zip_code": "sdasdasd",
"note": "PRO1-DISABLE-JNT-56770644-c14b-11ed-afa1-0242ac120002",
"status": "Accepted",
"landmark": "N/A"
},
"payment_information": {
"type": "COD",
"status": "Awaiting Payment",
"gateway": "N/A",
"reference_id": "N/A"
},
"shipping_information": {
"type": "Standard Delivery",
"shipped_by": "JNT"
},
"delivery_information": {
"vehicle_type": "N/A",
"status": "N/A",
"reference_number": "N/A"
},
"fees": {
"convenience_fee": 0,
"convenience_fee_customer": 0,
"shipping_fee": 0,
"payment_gateway_fee": 0,
"additional_fee": 0
},
"dimensions": {
"actual_weight": 12,
"volumetric_weight": 8.0905
},
"has_been_disbursed_to_merchant": false,
"requested_for_disbursement": false,
"disbursement_status": "ACCEPTED",
"disbursement_updated_by": [],
"createdAt": "2023-03-14T01:08:58.387Z",
"updatedAt": "2023-03-14T01:08:58.387Z",
"id": "640fc92a2742e57a81038b09",
"total_order_amount": 1000,
"cart_list": [
{
"store_id": "637de5eab94b30555121f36c",
"product_slug": null,
"product_id": "640576472a33e0ca3c940d0c",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"is_guest": true,
"cart_quantity": 1,
"item_sub_total": 1000,
"addon_ids": [],
"product_variant_combination_id": "",
"createdAt": "2023-03-14T01:08:45.604Z",
"updatedAt": "2023-03-14T01:08:45.604Z",
"id": "640fc91d2742e57a81038b05",
"dev_ref_id": "640fc91d2742e57a81038b05",
"published": true,
"selected_variant_combination_data": null,
"product_data": {
"product_seo": {
"primary": {
"title": "",
"description": "",
"url": "https://starcomputers.prodev.prosperna.ph/product/gaming-package-1"
}
},
"product_specification": {
"name": "Gaming Package 1",
"slug": "gaming-package-1",
"brand": "",
"short_description": "Entry Level Gaming Rig",
"long_description": "<p>Entry Level Gaming Rig</p>",
"images": [
{
"image": "https://p1-mediaserver.s3.ap-southeast-1.amazonaws.com/business/store/starcomputers/1678079639624-shopping.png",
"original_name": "shopping.png",
"type": "images/png",
"name_with_path": "business/store/starcomputers/1678079639624-shopping.png",
"position": 0,
"id": "640576972a33e0ca3c940d27"
}
]
},
"product_state": {
"is_product_has_variants": false,
"is_hide_stock": false,
"is_always_instock": false,
"is_published": true
},
"product_measurements": {
"product_size": {
"height": 12,
"length": 12,
"width": 12,
"unit": "in"
},
"product_weight": {
"weight": 12,
"unit": "kg"
}
},
"product_price": {
"regular_price": 1000,
"sale_price": 0,
"price_display": "",
"unit_cost": 0,
"margin": 0,
"stock_quantity": 981
},
"product_addons": {
"addOn_limit": 0,
"addOn_list": []
},
"product_categories": [
{
"name": "Gaming PC",
"id": "63f4221681bfa92d923d45f1"
}
],
"product_variant_types": [],
"product_type": "PHYSICAL",
"createdAt": "2023-03-06T05:12:39.534Z",
"updatedAt": "2023-03-13T06:47:16.677Z",
"id": "640576472a33e0ca3c940d0c",
"store_id": "637de5eab94b30555121f36c",
"product_variants_combinations": []
},
"selected_addon_data": []
}
],
"ordered_items_list": [
{
"order_id": "640fc92a2742e57a81038b08",
"store_id": "637de5eab94b30555121f36c",
"product_slug": null,
"product_id": "640576472a33e0ca3c940d0c",
"dev_ref_id": "640fc92a2742e57a81038b0b",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"is_guest": true,
"cart_quantity": 1,
"item_sub_total": 1000,
"addon_ids": [],
"product_variant_combination_id": "",
"selected_variant_combination_data": null,
"product_data": {
"product_seo": {
"primary": {
"title": "",
"description": "",
"url": "https://starcomputers.prodev.prosperna.ph/product/gaming-package-1"
}
},
"product_specification": {
"name": "Gaming Package 1",
"slug": "gaming-package-1",
"brand": "",
"short_description": "Entry Level Gaming Rig",
"long_description": "<p>Entry Level Gaming Rig</p>",
"images": [
{
"image": "https://p1-mediaserver.s3.ap-southeast-1.amazonaws.com/business/store/starcomputers/1678079639624-shopping.png",
"original_name": "shopping.png",
"type": "images/png",
"name_with_path": "business/store/starcomputers/1678079639624-shopping.png",
"position": 0,
"id": "640576972a33e0ca3c940d27"
}
]
},
"product_state": {
"is_product_has_variants": false,
"is_hide_stock": false,
"is_always_instock": false,
"is_published": true
},
"product_measurements": {
"product_size": {
"height": 12,
"length": 12,
"width": 12,
"unit": "in"
},
"product_weight": {
"weight": 12,
"unit": "kg"
}
},
"product_price": {
"regular_price": 1000,
"sale_price": 0,
"price_display": "",
"unit_cost": 0,
"margin": 0,
"stock_quantity": 981
},
"product_addons": {
"addOn_limit": 0,
"addOn_list": []
},
"product_categories": [
{
"name": "Gaming PC",
"id": "63f4221681bfa92d923d45f1"
}
],
"product_variant_types": [],
"product_type": "PHYSICAL",
"createdAt": "2023-03-06T05:12:39.534Z",
"updatedAt": "2023-03-13T06:47:16.677Z",
"id": "640576472a33e0ca3c940d0c",
"store_id": "637de5eab94b30555121f36c",
"product_variants_combinations": []
},
"selected_addon_data": [],
"createdAt": "2023-03-14T01:08:45.604Z",
"updatedAt": "2023-03-14T01:08:45.604Z",
"id": "640fc92a2742e57a81038b0b"
}
]
},
"message": "Order created successfully"
}
{
"name": "Error",
"message": "Cart data invalid."
}
/store?sid={store_id} Edit
Get Store Orders
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | ID of the Store |
Returns all orders from your store
var axios = require('axios');
var config = {
method: 'get',
maxBodyLength: Infinity,
url: 'https://api.prosperna.com/v1/orders/store?sid=63dc812b809e8c308d735e72'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"sid": "63dc812b809e8c308d735e72",
"data": [
{
"order_information": {
"fname": "JOHN ERIC",
"lname": "SIGUENZA",
"email_address": "jsiguenza+63dc812b809e8c308d735e72@prosperna.com",
"phone": "639461503583",
"address_line": "Z3",
"state": "BOHOL",
"city": "BOHOL-ALICIA",
"barangay": "LA HACIENDA",
"zip_code": "4405",
"landmark": "",
"note": "",
"status": "Completed",
"quotation": {
"country_region": ""
}
},
"payment_information": {
"type": "EWALLET",
"gateway": "PH_GCASH",
"status": "Paid",
"reference_id": "ewc_e4778b73-7096-40c7-a9ea-3bcc06174d58"
},
"shipping_information": {
"type": "Standard Delivery",
"shipped_by": "J&T"
},
"delivery_information": {
"vehicle_type": "N/A",
"status": "Processing",
"reference_number": "980002480311",
"meta_data": {
"success": "true",
"reason": "",
"txlogisticid": "pros1-63dc8397072db349e8b63bc9",
"mailno": "980002480311",
"sortingcode": "380-631091",
"sortingNo": "126"
}
},
"fees": {
"convenience_fee": 10.069700000000001,
"convenience_fee_customer": 5.0348500000000005,
"shipping_fee": 9.97,
"payment_gateway_fee": 25.17425,
"additional_fee": 0
},
"dimensions": {
"actual_weight": 0,
"volumetric_weight": 0.0003
},
"order_id": "63dc8397072db349e8b63bc9",
"store_id": "63dc812b809e8c308d735e72",
"customer_id": "63dc83508c85c650353ae450",
"cart_ids": [
"63dc8368072db349e8b63bc5"
],
"ordered_item_ids": [],
"is_trashed": false,
"order_total_amount": 1012.5,
"order_subtotal_amount": 997,
"order_total_qty": 1,
"has_been_disbursed_to_merchant": true,
"requested_for_disbursement": false,
"disbursement_status": "SUCCEEDED",
"disbursement_updated_by": [],
"createdAt": "2023-02-03T03:46:31.669Z",
"updatedAt": "2023-02-03T04:01:21.589Z",
"disbursement_reference_id": "P1-DISBURSE-3dac01bd-31c3-4d8c-bef9-363f95a1cd91",
"id": "63dc8397072db349e8b63bca",
"cart_items_list": [],
"ordered_items_list": [
{
"order_id": "63dc8397072db349e8b63bc9",
"store_id": "63dc812b809e8c308d735e72",
"product_slug": "product1",
"dev_ref_id": "63dc8399072db349e8b63bcc",
"customer_id": "63dc83508c85c650353ae450",
"is_guest": true,
"cart_quantity": 1,
"item_sub_total": 997,
"addon_ids": [],
"product_variant_combination_id": "",
"selected_variant_combination_data": null,
"product_data": {
"created_by": "63dc812b809e8c308d735e72",
"store_id": "63dc812b809e8c308d735e72",
"product_seo": {
"primary": {
"title": "",
"description": "",
"url": "https://maric100.prodev.prosperna.ph/product/product1"
}
},
"product_specification": {
"name": "Product1",
"slug": "product1",
"brand": "",
"description": "",
"images": [
{
"image": "https://p1-mediaserver.s3.ap-southeast-1.amazonaws.com/business/store/maric100/1675395507356-concrete-plaster-stone-brick-orange-3d-wall-mural_2.jpg",
"original_name": "concrete-plaster-stone-brick-orange-3d-wall-mural_2.jpg",
"type": "images/jpeg",
"name_with_path": "business/store/maric100/1675395507356-concrete-plaster-stone-brick-orange-3d-wall-mural_2.jpg",
"id": "63dc81b38ea1885610cb94f3"
}
],
"short_description": "",
"source": "P1"
},
"product_state": {
"is_product_has_variants": false,
"is_hide_stock": false,
"is_always_instock": false,
"is_published": true,
"is_imported": false,
"is_trashed": false,
"is_sold": false
},
"store_locations": [
{
"store_location_id": "63dc8178809e8c308d735ea0",
"stock_quantity": 999
}
],
"product_measurements": {
"product_size": {
"height": 1,
"length": 1,
"width": 1,
"unit": "cm"
},
"product_weight": {
"weight": 0,
"unit": "kg"
}
},
"product_price": {
"regular_price": 997,
"sale_price": null,
"price_display": "",
"unit_cost": null,
"margin": null
},
"product_addons": {
"addOn_list": [],
"addOn_limit": 0
},
"promo_codes": [],
"product_reviews": [],
"product_variants": [],
"createdAt": "2023-02-03T03:38:27.480Z",
"updatedAt": "2023-02-03T03:43:20.871Z",
"id": "63dc81b38ea1885610cb94f0",
"product_categories": [
{
"category_type": "main",
"title": "main",
"image": "https://p1-mediaserver.s3.ap-southeast-1.amazonaws.com/business/store/merchant/categories/concrete-plaster-stone-brick-orange-3d-wall-mural_2.jpg",
"sub_categories": [],
"createdAt": "2023-02-03T03:38:05.221Z",
"updatedAt": "2023-02-03T03:38:05.221Z",
"id": "63dc819d8ea1885610cb94ec"
}
],
"product_variant_combinations": [],
"product_variant_type_ids": []
},
"selected_addon_data": [],
"createdAt": "2023-02-03T03:45:44.370Z",
"updatedAt": "2023-02-03T03:45:44.370Z",
"id": "63dc8399072db349e8b63bcc"
}
],
"order_coupons": []
}
]
}
/:id Edit
Deletes a Order
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| sid | string | Yes | ID of the Store |
| cid | string | Yes | ID of the Consumer |
| Path Variables | Data Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | ID of the Order |
Deletes a order in your collection.
var axios = require('axios');
var config = {
method: 'delete',
maxBodyLength: Infinity,
url: 'https://api.prosperna.com/v1/orders/6395690183b8967af19222f9?sid=6386ae5dba4bf984402d848e&cid=3945a7bb-b2d9-4b6c-8d41-2db4d56fc4ec'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"message": "Delete successful"
}
/order_id?sid=""&cid="" Edit
Update Order
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| sid | string | Yes | ID of the Store |
| cid | string | Yes | ID of the Consumer |
| Path Variables | Data Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | ID of the Order |
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | No | ID of the Store |
| customer_id | string | No | ID of the Consumer |
| cart_id | string | No | ID of the Cart of Consumer |
| urls | object | No | Redirection URLs for Order API result. Possible values: { “success_redirect_url”: “https://www.google.com/search?q=success”, “failure_redirect_url”: “https://www.google.com/search?q=failed”, “cancel_redirect_url”: “https://www.google.com/search?q=cancel” } |
| order_information | object | No | Possible values: { “fname”: “Juan”, “lname”: “Dela Cruz”, “email_address”: “email@email.com”, “phone”: “639685432321”, “address_line”: “Star Building”, “state”: “METRO-MANILA”, “city”: “BINONDO”, “barangay”: “BARANGAY 287”, “zip_code”: “1234”, “note”: “” } |
| shipping_information | object | No | Possible values: { “type”: (Possible types: “STANDARD_JNT”, “OWN_BOOKING”, “PICKUP”, “SAMEDAY_SCHED_LALAMOVE”) } |
| dimensions | object | No | Dimensions of the Ordered Product. Possible values: { “actual_weight”: 12, “volumetric_weight”: 8.0905 } |
| payment_information | object | No | Possible values: { “type”: (Possible types: “EWALLET”, “OVER_THE_COUNTER”, “COP”, “COD”, “CREDIT_CARD”) } |
| fees | object | No | Possible values: { “convenience_fee”: 0, “convenience_fee_customer”: 0, “shipping_fee”: 0, “additional_fee”: 0 } |
var axios = require('axios');
var data = JSON.stringify({
"delivery_information": {
"vehicle_type": "N/A",
"status": "N/A",
"reference_number": "167180805411"
}
});
var config = {
method: 'patch',
maxBodyLength: Infinity,
url: 'https://api.prosperna.com/v1/orders/640fc92a2742e57a81038b09?sid=637de5eab94b30555121f36c&cid=453c955e-ae65-4975-8bf1-c8dd98892c60',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
title: Request
language: json
{
"data": {
"order_information": {
"fname": "TEST",
"lname": "ORDER",
"email_address": "ian+637de5eab94b30555121f36c@prosperna.com",
"phone": "639685432321",
"address_line": "sdasdasd",
"state": "METRO-MANILA",
"city": "BINONDO",
"barangay": "BARANGAY 287",
"zip_code": "sdasdasd",
"note": "PRO1-DISABLE-JNT-56770644-c14b-11ed-afa1-0242ac120002",
"status": "Accepted",
"landmark": "N/A"
},
"payment_information": {
"type": "COD",
"status": "Awaiting Payment",
"gateway": "N/A",
"reference_id": "N/A"
},
"shipping_information": {
"type": "Standard Delivery",
"shipped_by": "JNT"
},
"delivery_information": {
"vehicle_type": "N/A",
"status": "N/A",
"reference_number": "167180805411"
},
"fees": {
"convenience_fee": 0,
"convenience_fee_customer": 0,
"shipping_fee": 0,
"payment_gateway_fee": 0,
"additional_fee": 0
},
"dimensions": {
"actual_weight": 12,
"volumetric_weight": 8.0905
},
"order_id": "640fc92a2742e57a81038b08",
"store_id": "637de5eab94b30555121f36c",
"customer_id": "453c955e-ae65-4975-8bf1-c8dd98892c60",
"cart_ids": [
"640fc91d2742e57a81038b05"
],
"ordered_item_ids": [],
"is_trashed": false,
"order_total_amount": 1000,
"order_subtotal_amount": 1000,
"order_total_qty": 1,
"has_been_disbursed_to_merchant": false,
"requested_for_disbursement": false,
"disbursement_status": "ACCEPTED",
"disbursement_updated_by": [],
"createdAt": "2023-03-14T01:08:58.387Z",
"updatedAt": "2023-03-14T01:22:33.305Z",
"id": "640fc92a2742e57a81038b09"
},
"message": "Order updated successfully"
}
{
"name": "Error",
"message": "Failed to update order."
}
/business-profile/ph-locale/regions Edit
Get all Philippine regions
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/ph-locale/regions',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve PH regions.",
"data": {
"regions": [
{
"_id": "60530f205d8baa22bcb55921",
"regionName": "BARMM",
"regionShortName": "BARMM",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55922",
"regionName": "CAR",
"regionShortName": "CAR",
"dateCreated": "2021-03-18T08:28:16.224Z",
"lastUpdated": "2021-03-18T08:28:16.224Z"
},
{
"_id": "60530f205d8baa22bcb55923",
"regionName": "NCR",
"regionShortName": "NCR",
"dateCreated": "2021-03-18T08:28:16.224Z",
"lastUpdated": "2021-03-18T08:28:16.224Z"
},
{
"_id": "60530f205d8baa22bcb55917",
"regionName": "REGION I",
"regionShortName": "01",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55918",
"regionName": "REGION II",
"regionShortName": "02",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55919",
"regionName": "REGION III",
"regionShortName": "03",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591a",
"regionName": "REGION IV-A",
"regionShortName": "4A",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591b",
"regionName": "REGION IV-B",
"regionShortName": "4B",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55920",
"regionName": "REGION IX",
"regionShortName": "09",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591c",
"regionName": "REGION V",
"regionShortName": "05",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591d",
"regionName": "REGION VI",
"regionShortName": "06",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591e",
"regionName": "REGION VII",
"regionShortName": "07",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591f",
"regionName": "REGION VIII",
"regionShortName": "08",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55913",
"regionName": "REGION X",
"regionShortName": "10",
"dateCreated": "2021-03-18T08:28:16.222Z",
"lastUpdated": "2021-03-18T08:28:16.222Z"
},
{
"_id": "60530f205d8baa22bcb55914",
"regionName": "REGION XI",
"regionShortName": "11",
"dateCreated": "2021-03-18T08:28:16.222Z",
"lastUpdated": "2021-03-18T08:28:16.222Z"
},
{
"_id": "60530f205d8baa22bcb55915",
"regionName": "REGION XII",
"regionShortName": "12",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55916",
"regionName": "REGION XIII",
"regionShortName": "13",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
}
]
}
}
/business-profile/ph-locale/provinces Edit
Get all Philippine provinces
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/ph-locale/provinces',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve PH provinces.",
"data": {
"provinces": [
{
"_id": "60530f205d8baa22bcb5596f",
"provinceName": "Abra",
"provinceNameUppercased": "ABRA",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55932",
"provinceName": "Agusan Del Norte",
"provinceNameUppercased": "AGUSAN DEL NORTE",
"region": "60530f205d8baa22bcb55916",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb55933",
"provinceName": "Agusan Del Sur",
"provinceNameUppercased": "AGUSAN DEL SUR",
"region": "60530f205d8baa22bcb55916",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb55957",
"provinceName": "Aklan",
"provinceNameUppercased": "AKLAN",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.394Z",
"lastUpdated": "2021-03-18T08:28:16.395Z"
},
{
"_id": "60530f205d8baa22bcb55951",
"provinceName": "Albay",
"provinceNameUppercased": "ALBAY",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55958",
"provinceName": "Antique",
"provinceNameUppercased": "ANTIQUE",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.395Z",
"lastUpdated": "2021-03-18T08:28:16.395Z"
},
{
"_id": "60530f205d8baa22bcb55970",
"provinceName": "Apayao",
"provinceNameUppercased": "APAYAO",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55940",
"provinceName": "Aurora",
"provinceNameUppercased": "AURORA",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5596a",
"provinceName": "Basilan",
"provinceNameUppercased": "BASILAN",
"region": "60530f205d8baa22bcb55921",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55941",
"provinceName": "Bataan",
"provinceNameUppercased": "BATAAN",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5593b",
"provinceName": "Batanes",
"provinceNameUppercased": "BATANES",
"region": "60530f205d8baa22bcb55918",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55947",
"provinceName": "Batangas",
"provinceNameUppercased": "BATANGAS",
"region": "60530f205d8baa22bcb5591a",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb55971",
"provinceName": "Benguet",
"provinceNameUppercased": "BENGUET",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55961",
"provinceName": "Biliran",
"provinceNameUppercased": "BILIRAN",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb5595d",
"provinceName": "Bohol",
"provinceNameUppercased": "BOHOL",
"region": "60530f205d8baa22bcb5591e",
"dateCreated": "2021-03-18T08:28:16.400Z",
"lastUpdated": "2021-03-18T08:28:16.400Z"
},
{
"_id": "60530f205d8baa22bcb55924",
"provinceName": "Bukidnon",
"provinceNameUppercased": "BUKIDNON",
"region": "60530f205d8baa22bcb55913",
"dateCreated": "2021-03-18T08:28:16.388Z",
"lastUpdated": "2021-03-18T08:28:16.388Z"
},
{
"_id": "60530f205d8baa22bcb55942",
"provinceName": "Bulacan",
"provinceNameUppercased": "BULACAN",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5593c",
"provinceName": "Cagayan",
"provinceNameUppercased": "CAGAYAN",
"region": "60530f205d8baa22bcb55918",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55952",
"provinceName": "Camarines Norte",
"provinceNameUppercased": "CAMARINES NORTE",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55953",
"provinceName": "Camarines Sur",
"provinceNameUppercased": "CAMARINES SUR",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55925",
"provinceName": "Camiguin",
"provinceNameUppercased": "CAMIGUIN",
"region": "60530f205d8baa22bcb55913",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb55959",
"provinceName": "Capiz",
"provinceNameUppercased": "CAPIZ",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.396Z",
"lastUpdated": "2021-03-18T08:28:16.396Z"
},
{
"_id": "60530f205d8baa22bcb55954",
"provinceName": "Catanduanes",
"provinceNameUppercased": "CATANDUANES",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.394Z",
"lastUpdated": "2021-03-18T08:28:16.394Z"
},
{
"_id": "60530f205d8baa22bcb55948",
"provinceName": "Cavite",
"provinceNameUppercased": "CAVITE",
"region": "60530f205d8baa22bcb5591a",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5595e",
"provinceName": "Cebu",
"provinceNameUppercased": "CEBU",
"region": "60530f205d8baa22bcb5591e",
"dateCreated": "2021-03-18T08:28:16.400Z",
"lastUpdated": "2021-03-18T08:28:16.400Z"
},
{
"_id": "60530f205d8baa22bcb55929",
"provinceName": "Compostela Valley",
"provinceNameUppercased": "COMPOSTELA VALLEY",
"region": "60530f205d8baa22bcb55914",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb5592e",
"provinceName": "Cotabato (North Cot.)",
"provinceNameUppercased": "COTABATO (NORTH COT.)",
"region": "60530f205d8baa22bcb55915",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb5592a",
"provinceName": "Davao (Davao Del Norte)",
"provinceNameUppercased": "DAVAO (DAVAO DEL NORTE)",
"region": "60530f205d8baa22bcb55914",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb5592b",
"provinceName": "Davao Del Sur",
"provinceNameUppercased": "DAVAO DEL SUR",
"region": "60530f205d8baa22bcb55914",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb5592c",
"provinceName": "Davao Occidental",
"provinceNameUppercased": "DAVAO OCCIDENTAL",
"region": "60530f205d8baa22bcb55914",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb5592d",
"provinceName": "Davao Oriental",
"provinceNameUppercased": "DAVAO ORIENTAL",
"region": "60530f205d8baa22bcb55914",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb55934",
"provinceName": "Dinagat Islands",
"provinceNameUppercased": "DINAGAT ISLANDS",
"region": "60530f205d8baa22bcb55916",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55962",
"provinceName": "Eastern Samar",
"provinceNameUppercased": "EASTERN SAMAR",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb5595a",
"provinceName": "Guimaras",
"provinceNameUppercased": "GUIMARAS",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.398Z",
"lastUpdated": "2021-03-18T08:28:16.398Z"
},
{
"_id": "60530f205d8baa22bcb55972",
"provinceName": "Ifugao",
"provinceNameUppercased": "IFUGAO",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55937",
"provinceName": "Ilocos Norte",
"provinceNameUppercased": "ILOCOS NORTE",
"region": "60530f205d8baa22bcb55917",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55938",
"provinceName": "Ilocos Sur",
"provinceNameUppercased": "ILOCOS SUR",
"region": "60530f205d8baa22bcb55917",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb5595b",
"provinceName": "Iloilo",
"provinceNameUppercased": "ILOILO",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.399Z",
"lastUpdated": "2021-03-18T08:28:16.399Z"
},
{
"_id": "60530f205d8baa22bcb5593d",
"provinceName": "Isabela",
"provinceNameUppercased": "ISABELA",
"region": "60530f205d8baa22bcb55918",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55973",
"provinceName": "Kalinga",
"provinceNameUppercased": "KALINGA",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55939",
"provinceName": "La Union",
"provinceNameUppercased": "LA UNION",
"region": "60530f205d8baa22bcb55917",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55949",
"provinceName": "Laguna",
"provinceNameUppercased": "LAGUNA",
"region": "60530f205d8baa22bcb5591a",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb55926",
"provinceName": "Lanao Del Norte",
"provinceNameUppercased": "LANAO DEL NORTE",
"region": "60530f205d8baa22bcb55913",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb5596b",
"provinceName": "Lanao Del Sur",
"provinceNameUppercased": "LANAO DEL SUR",
"region": "60530f205d8baa22bcb55921",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55963",
"provinceName": "Leyte",
"provinceNameUppercased": "LEYTE",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb5596c",
"provinceName": "Maguindanao",
"provinceNameUppercased": "MAGUINDANAO",
"region": "60530f205d8baa22bcb55921",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb5594c",
"provinceName": "Marinduque",
"provinceNameUppercased": "MARINDUQUE",
"region": "60530f205d8baa22bcb5591b",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55955",
"provinceName": "Masbate",
"provinceNameUppercased": "MASBATE",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.394Z",
"lastUpdated": "2021-03-18T08:28:16.394Z"
},
{
"_id": "60530f205d8baa22bcb55927",
"provinceName": "Misamis Occidental",
"provinceNameUppercased": "MISAMIS OCCIDENTAL",
"region": "60530f205d8baa22bcb55913",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb55928",
"provinceName": "Misamis Oriental",
"provinceNameUppercased": "MISAMIS ORIENTAL",
"region": "60530f205d8baa22bcb55913",
"dateCreated": "2021-03-18T08:28:16.389Z",
"lastUpdated": "2021-03-18T08:28:16.389Z"
},
{
"_id": "60530f205d8baa22bcb55974",
"provinceName": "Mountain Province",
"provinceNameUppercased": "MOUNTAIN PROVINCE",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:16.404Z",
"lastUpdated": "2021-03-18T08:28:16.404Z"
},
{
"_id": "60530f205d8baa22bcb55976",
"provinceName": "National Capital Region - Metro Manila",
"provinceNameUppercased": "NATIONAL CAPITAL REGION - METRO MANILA",
"region": "60530f205d8baa22bcb55923",
"dateCreated": "2021-03-18T08:28:16.404Z",
"lastUpdated": "2021-03-18T08:28:16.404Z"
},
{
"_id": "60530f205d8baa22bcb5595c",
"provinceName": "Negros Occidental",
"provinceNameUppercased": "NEGROS OCCIDENTAL",
"region": "60530f205d8baa22bcb5591d",
"dateCreated": "2021-03-18T08:28:16.400Z",
"lastUpdated": "2021-03-18T08:28:16.400Z"
},
{
"_id": "60530f205d8baa22bcb5595f",
"provinceName": "Negros Oriental",
"provinceNameUppercased": "NEGROS ORIENTAL",
"region": "60530f205d8baa22bcb5591e",
"dateCreated": "2021-03-18T08:28:16.401Z",
"lastUpdated": "2021-03-18T08:28:16.401Z"
},
{
"_id": "60530f205d8baa22bcb55964",
"provinceName": "Northern Samar",
"provinceNameUppercased": "NORTHERN SAMAR",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb55943",
"provinceName": "Nueva Ecija",
"provinceNameUppercased": "NUEVA ECIJA",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5593e",
"provinceName": "Nueva Vizcaya",
"provinceNameUppercased": "NUEVA VIZCAYA",
"region": "60530f205d8baa22bcb55918",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb5594d",
"provinceName": "Occidental Mindoro",
"provinceNameUppercased": "OCCIDENTAL MINDORO",
"region": "60530f205d8baa22bcb5591b",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb5594e",
"provinceName": "Oriental Mindoro",
"provinceNameUppercased": "ORIENTAL MINDORO",
"region": "60530f205d8baa22bcb5591b",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb5594f",
"provinceName": "Palawan",
"provinceNameUppercased": "PALAWAN",
"region": "60530f205d8baa22bcb5591b",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55944",
"provinceName": "Pampanga",
"provinceNameUppercased": "PAMPANGA",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5593a",
"provinceName": "Pangasinan",
"provinceNameUppercased": "PANGASINAN",
"region": "60530f205d8baa22bcb55917",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb5594a",
"provinceName": "Quezon",
"provinceNameUppercased": "QUEZON",
"region": "60530f205d8baa22bcb5591a",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb5593f",
"provinceName": "Quirino",
"provinceNameUppercased": "QUIRINO",
"region": "60530f205d8baa22bcb55918",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5594b",
"provinceName": "Rizal",
"provinceNameUppercased": "RIZAL",
"region": "60530f205d8baa22bcb5591a",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55950",
"provinceName": "Romblon",
"provinceNameUppercased": "ROMBLON",
"region": "60530f205d8baa22bcb5591b",
"dateCreated": "2021-03-18T08:28:16.393Z",
"lastUpdated": "2021-03-18T08:28:16.393Z"
},
{
"_id": "60530f205d8baa22bcb55965",
"provinceName": "Samar (Western Samar)",
"provinceNameUppercased": "SAMAR (WESTERN SAMAR)",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb5592f",
"provinceName": "Sarangani",
"provinceNameUppercased": "SARANGANI",
"region": "60530f205d8baa22bcb55915",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb55960",
"provinceName": "Siquijor",
"provinceNameUppercased": "SIQUIJOR",
"region": "60530f205d8baa22bcb5591e",
"dateCreated": "2021-03-18T08:28:16.401Z",
"lastUpdated": "2021-03-18T08:28:16.401Z"
},
{
"_id": "60530f205d8baa22bcb55956",
"provinceName": "Sorsogon",
"provinceNameUppercased": "SORSOGON",
"region": "60530f205d8baa22bcb5591c",
"dateCreated": "2021-03-18T08:28:16.394Z",
"lastUpdated": "2021-03-18T08:28:16.394Z"
},
{
"_id": "60530f205d8baa22bcb55930",
"provinceName": "South Cotabato",
"provinceNameUppercased": "SOUTH COTABATO",
"region": "60530f205d8baa22bcb55915",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb55966",
"provinceName": "Southern Leyte",
"provinceNameUppercased": "SOUTHERN LEYTE",
"region": "60530f205d8baa22bcb5591f",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb55931",
"provinceName": "Sultan Kudarat",
"provinceNameUppercased": "SULTAN KUDARAT",
"region": "60530f205d8baa22bcb55915",
"dateCreated": "2021-03-18T08:28:16.390Z",
"lastUpdated": "2021-03-18T08:28:16.390Z"
},
{
"_id": "60530f205d8baa22bcb5596d",
"provinceName": "Sulu",
"provinceNameUppercased": "SULU",
"region": "60530f205d8baa22bcb55921",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55935",
"provinceName": "Surigao Del Norte",
"provinceNameUppercased": "SURIGAO DEL NORTE",
"region": "60530f205d8baa22bcb55916",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55936",
"provinceName": "Surigao Del Sur",
"provinceNameUppercased": "SURIGAO DEL SUR",
"region": "60530f205d8baa22bcb55916",
"dateCreated": "2021-03-18T08:28:16.391Z",
"lastUpdated": "2021-03-18T08:28:16.391Z"
},
{
"_id": "60530f205d8baa22bcb55945",
"provinceName": "Tarlac",
"provinceNameUppercased": "TARLAC",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb5596e",
"provinceName": "Tawi-Tawi",
"provinceNameUppercased": "TAWI-TAWI",
"region": "60530f205d8baa22bcb55921",
"dateCreated": "2021-03-18T08:28:16.403Z",
"lastUpdated": "2021-03-18T08:28:16.403Z"
},
{
"_id": "60530f205d8baa22bcb55946",
"provinceName": "Zambales",
"provinceNameUppercased": "ZAMBALES",
"region": "60530f205d8baa22bcb55919",
"dateCreated": "2021-03-18T08:28:16.392Z",
"lastUpdated": "2021-03-18T08:28:16.392Z"
},
{
"_id": "60530f205d8baa22bcb55967",
"provinceName": "Zamboanga Del Norte",
"provinceNameUppercased": "ZAMBOANGA DEL NORTE",
"region": "60530f205d8baa22bcb55920",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb55968",
"provinceName": "Zamboanga Del Sur",
"provinceNameUppercased": "ZAMBOANGA DEL SUR",
"region": "60530f205d8baa22bcb55920",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
},
{
"_id": "60530f205d8baa22bcb55969",
"provinceName": "Zamboanga Sibugay",
"provinceNameUppercased": "ZAMBOANGA SIBUGAY",
"region": "60530f205d8baa22bcb55920",
"dateCreated": "2021-03-18T08:28:16.402Z",
"lastUpdated": "2021-03-18T08:28:16.402Z"
}
]
}
}
/business-profile/ph-locale/provinces/:regionId Edit
Get all Philippine provinces via region id
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| regionId | string | Yes | Region id |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/ph-locale/provinces/60530f205d8baa22bcb55921'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve PH regions.",
"data": {
"regions": [
{
"_id": "60530f205d8baa22bcb55921",
"regionName": "BARMM",
"regionShortName": "BARMM",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55922",
"regionName": "CAR",
"regionShortName": "CAR",
"dateCreated": "2021-03-18T08:28:16.224Z",
"lastUpdated": "2021-03-18T08:28:16.224Z"
},
{
"_id": "60530f205d8baa22bcb55923",
"regionName": "NCR",
"regionShortName": "NCR",
"dateCreated": "2021-03-18T08:28:16.224Z",
"lastUpdated": "2021-03-18T08:28:16.224Z"
},
{
"_id": "60530f205d8baa22bcb55917",
"regionName": "REGION I",
"regionShortName": "01",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55918",
"regionName": "REGION II",
"regionShortName": "02",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55919",
"regionName": "REGION III",
"regionShortName": "03",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591a",
"regionName": "REGION IV-A",
"regionShortName": "4A",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591b",
"regionName": "REGION IV-B",
"regionShortName": "4B",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55920",
"regionName": "REGION IX",
"regionShortName": "09",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591c",
"regionName": "REGION V",
"regionShortName": "05",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591d",
"regionName": "REGION VI",
"regionShortName": "06",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591e",
"regionName": "REGION VII",
"regionShortName": "07",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb5591f",
"regionName": "REGION VIII",
"regionShortName": "08",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55913",
"regionName": "REGION X",
"regionShortName": "10",
"dateCreated": "2021-03-18T08:28:16.222Z",
"lastUpdated": "2021-03-18T08:28:16.222Z"
},
{
"_id": "60530f205d8baa22bcb55914",
"regionName": "REGION XI",
"regionShortName": "11",
"dateCreated": "2021-03-18T08:28:16.222Z",
"lastUpdated": "2021-03-18T08:28:16.222Z"
},
{
"_id": "60530f205d8baa22bcb55915",
"regionName": "REGION XII",
"regionShortName": "12",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
},
{
"_id": "60530f205d8baa22bcb55916",
"regionName": "REGION XIII",
"regionShortName": "13",
"dateCreated": "2021-03-18T08:28:16.223Z",
"lastUpdated": "2021-03-18T08:28:16.223Z"
}
]
}
}
/business-profile/ph-locale/municipalities/:provinceId Edit
Get all Philippine municipalities via province id
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| provinceId | string | Yes | Province id |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/ph-locale/municipalities/60530f205d8baa22bcb5596f',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve PH municipalities by province ID.",
"data": {
"municipalities": [
{
"_id": "60530f215d8baa22bcb55f7e",
"municipalityName": "Bangued",
"municipalityNameUppercased": "BANGUED",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f7f",
"municipalityName": "Boliney",
"municipalityNameUppercased": "BOLINEY",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f80",
"municipalityName": "Bucay",
"municipalityNameUppercased": "BUCAY",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f81",
"municipalityName": "Bucloc",
"municipalityNameUppercased": "BUCLOC",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f82",
"municipalityName": "Daguioman",
"municipalityNameUppercased": "DAGUIOMAN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f83",
"municipalityName": "Danglas",
"municipalityNameUppercased": "DANGLAS",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f84",
"municipalityName": "Dolores",
"municipalityNameUppercased": "DOLORES",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f85",
"municipalityName": "La Paz",
"municipalityNameUppercased": "LA PAZ",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f86",
"municipalityName": "Lacub",
"municipalityNameUppercased": "LACUB",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f87",
"municipalityName": "Lagangilang",
"municipalityNameUppercased": "LAGANGILANG",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f88",
"municipalityName": "Lagayan",
"municipalityNameUppercased": "LAGAYAN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f89",
"municipalityName": "Langiden",
"municipalityNameUppercased": "LANGIDEN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.145Z",
"lastUpdated": "2021-03-18T08:28:17.145Z"
},
{
"_id": "60530f215d8baa22bcb55f8a",
"municipalityName": "Licuan-Baay (Licuan)",
"municipalityNameUppercased": "LICUAN-BAAY (LICUAN)",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f8b",
"municipalityName": "Luba",
"municipalityNameUppercased": "LUBA",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f8c",
"municipalityName": "Malibcong",
"municipalityNameUppercased": "MALIBCONG",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f8d",
"municipalityName": "Manabo",
"municipalityNameUppercased": "MANABO",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f8e",
"municipalityName": "PeÑArrubia",
"municipalityNameUppercased": "PEÑARRUBIA",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f8f",
"municipalityName": "Pidigan",
"municipalityNameUppercased": "PIDIGAN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f90",
"municipalityName": "Pilar",
"municipalityNameUppercased": "PILAR",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f91",
"municipalityName": "Sallapadan",
"municipalityNameUppercased": "SALLAPADAN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f92",
"municipalityName": "San Isidro",
"municipalityNameUppercased": "SAN ISIDRO",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f93",
"municipalityName": "San Juan",
"municipalityNameUppercased": "SAN JUAN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f94",
"municipalityName": "San Quintin",
"municipalityNameUppercased": "SAN QUINTIN",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f95",
"municipalityName": "Tayum",
"municipalityNameUppercased": "TAYUM",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f96",
"municipalityName": "Tineg",
"municipalityNameUppercased": "TINEG",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f97",
"municipalityName": "Tubo",
"municipalityNameUppercased": "TUBO",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
},
{
"_id": "60530f215d8baa22bcb55f98",
"municipalityName": "Villaviciosa",
"municipalityNameUppercased": "VILLAVICIOSA",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:17.146Z",
"lastUpdated": "2021-03-18T08:28:17.146Z"
}
]
}
}
/business-profile/ph-locale/barangays/:municipalityId Edit
Get all Philippine barangay via municipality id
| Parameters | Data Type | Required | Description |
|---|---|---|---|
| municipalityId | string | Yes | Municipality id |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/ph-locale/barangays/:municipalityId',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve PH barangays by municipality ID.",
"data": {
"barangays": [
{
"_id": "60530f265d8baa22bcb5f314",
"barangayName": "Ableg",
"barangayNameUppercased": "ABLEG",
"municipality": "60530f215d8baa22bcb55f82",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:22.397Z",
"lastUpdated": "2021-03-18T08:28:22.397Z"
},
{
"_id": "60530f265d8baa22bcb5f315",
"barangayName": "Cabaruyan",
"barangayNameUppercased": "CABARUYAN",
"municipality": "60530f215d8baa22bcb55f82",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:22.397Z",
"lastUpdated": "2021-03-18T08:28:22.397Z"
},
{
"_id": "60530f265d8baa22bcb5f316",
"barangayName": "Pikek",
"barangayNameUppercased": "PIKEK",
"municipality": "60530f215d8baa22bcb55f82",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:22.397Z",
"lastUpdated": "2021-03-18T08:28:22.397Z"
},
{
"_id": "60530f265d8baa22bcb5f317",
"barangayName": "Tui (Pob.)",
"barangayNameUppercased": "TUI (POB.)",
"municipality": "60530f215d8baa22bcb55f82",
"province": "60530f205d8baa22bcb5596f",
"region": "60530f205d8baa22bcb55922",
"dateCreated": "2021-03-18T08:28:22.397Z",
"lastUpdated": "2021-03-18T08:28:22.397Z"
}
]
}
}
/business-profile/industries Edit
Get industry list
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/industries',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve industries.",
"data": {
"count": 30,
"industries": [
{
"_id": "63b6eb7b7ed0a8312a834630",
"industryName": "Agency",
"industryLabel": "Agency"
},
{
"_id": "63b6eb7b7ed0a8312a834631",
"industryName": "Agriculture",
"industryLabel": "Agriculture"
},
{
"_id": "63b6eb7b7ed0a8312a834632",
"industryName": "Arts & Crafts",
"industryLabel": "Arts & Crafts"
},
{
"_id": "63b6eb7b7ed0a8312a834633",
"industryName": "Automotive",
"industryLabel": "Automotive"
},
{
"_id": "63b6eb7b7ed0a8312a834634",
"industryName": "Bakery",
"industryLabel": "Bakery"
},
{
"_id": "63b6eb7b7ed0a8312a834635",
"industryName": "Beer & Wine",
"industryLabel": "Beer & Wine"
},
{
"_id": "63b6eb7b7ed0a8312a834636",
"industryName": "Bike Shop",
"industryLabel": "Bike Shop"
},
{
"_id": "63b6eb7b7ed0a8312a834637",
"industryName": "Coffee Shop",
"industryLabel": "Coffee Shop"
},
{
"_id": "63b6eb7b7ed0a8312a834638",
"industryName": "Construction",
"industryLabel": "Construction"
},
{
"_id": "63b6eb7b7ed0a8312a834639",
"industryName": "Digital/Downloadable Products",
"industryLabel": "Digital/Downloadable Products"
},
{
"_id": "63b6eb7b7ed0a8312a83463a",
"industryName": "Education",
"industryLabel": "Education"
},
{
"_id": "63b6eb7b7ed0a8312a83463b",
"industryName": "Electronics",
"industryLabel": "Electronics"
},
{
"_id": "63b6eb7b7ed0a8312a83463c",
"industryName": "Fashion & Apparel",
"industryLabel": "Fashion & Apparel"
},
{
"_id": "63b6eb7b7ed0a8312a83463d",
"industryName": "Financial & Insurance Services",
"industryLabel": "Financial & Insurance Services"
},
{
"_id": "63b6eb7b7ed0a8312a83463e",
"industryName": "Footwear",
"industryLabel": "Footwear"
},
{
"_id": "63b6eb7b7ed0a8312a83463f",
"industryName": "Grocery",
"industryLabel": "Grocery"
},
{
"_id": "63b6eb7b7ed0a8312a834640",
"industryName": "Health & Beauty",
"industryLabel": "Health & Beauty"
},
{
"_id": "63b6eb7b7ed0a8312a834641",
"industryName": "Home Furnishings",
"industryLabel": "Home Furnishings"
},
{
"_id": "63b6eb7b7ed0a8312a834642",
"industryName": "Jewelry",
"industryLabel": "Jewelry"
},
{
"_id": "63b6eb7b7ed0a8312a834643",
"industryName": "Not for Profit",
"industryLabel": "Not for Profit"
},
{
"_id": "63b6eb7b7ed0a8312a834644",
"industryName": "Pet Care & Supply",
"industryLabel": "Pet Care & Supply"
},
{
"_id": "63b6eb7b7ed0a8312a834645",
"industryName": "Pharmacy",
"industryLabel": "Pharmacy"
},
{
"_id": "63b6eb7b7ed0a8312a834646",
"industryName": "Printing",
"industryLabel": "Printing"
},
{
"_id": "63b6eb7b7ed0a8312a834647",
"industryName": "Professional Services",
"industryLabel": "Professional Services"
},
{
"_id": "63b6eb7b7ed0a8312a834649",
"industryName": "Real Estate",
"industryLabel": "Real Estate"
},
{
"_id": "63b6eb7b7ed0a8312a834648",
"industryName": "Restaurant",
"industryLabel": "Restaurant"
},
{
"_id": "63b6eb7b7ed0a8312a83464a",
"industryName": "Sporting Goods",
"industryLabel": "Sporting Goods"
},
{
"_id": "63b6eb7b7ed0a8312a83464b",
"industryName": "Travel & Hospitality",
"industryLabel": "Travel & Hospitality"
},
{
"_id": "63b6eb7b7ed0a8312a83464c",
"industryName": "Venture Capital",
"industryLabel": "Venture Capital"
},
{
"_id": "63b6eb7b7ed0a8312a83464d",
"industryName": "Other",
"industryLabel": "Other"
}
]
}
}
/business-profile/banks Edit
Get all supported banks
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/banks',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve banks.",
"data": {
"banks": [
{
"_id": "605433499138600528eb767b",
"bankName": "UNIONBANK",
"xenditBankChannelCode": "PH_UBP",
"country": "PH"
},
{
"_id": "605433319138600528eb7679",
"bankName": "BDO",
"xenditBankChannelCode": "PH_BDO",
"country": "PH"
},
{
"_id": "605433439138600528eb767a",
"bankName": "BPI",
"xenditBankChannelCode": "PH_BPI",
"country": "PH"
},
{
"_id": "61483124264faf4dae5f5147",
"bankName": "GCASH",
"xenditBankChannelCode": "PH_GCASH",
"country": "PH"
}
]
}
}
/business-profile/store/update/store-info Edit
Save/Update store information
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| storeName | string | Yes | Updated store name |
| storeIndustry | string | Yes | Updated store industry, use the industry id |
| storeSlogan | string | Yes | Updated store slogan |
| storeSharingPrefixDesc | string | Yes | Updated sharing prefix description |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"storeName": "updated_store_name",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSlogan": "New slogan",
"storeSharingPrefixDesc": ""
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-info',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Your store has been successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-social-media Edit
Save/Update store social media information
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| instagramLink | string | No | Updated store Instagram page |
| facebookLink | string | No | Updated store Facebook page |
| twitterLink | string | No | Updated store Twitter page |
| linkedinLink | string | No | Updated store Linkedin page |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"instagramLink": "",
"facebookLink": "",
"twitterLink": "",
"linkedinLink": ""
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-social-media',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Social media link successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-branding Edit
Save/Update store branding
| Form Data | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| storeLogo | binary | No | Updated store logo |
| storeFavicon | binary | No | Updated store favicon |
var axios = require('axios');
var FormData = require('form-data');
var fs = require('fs');
var data = new FormData();
data.append('storeId', '63760ee5a3444c4d444c158c');
data.append('storeLogo', fs.createReadStream('storelogo.png'));
data.append('storeFavicon', fs.createReadStream('storefavicon.png'));
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-branding',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Store branding successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-pixel Edit
Save/Update store FB Pixel tracking code
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| storeFbPixel | string | Yes | PAID FEATURE Updated store FB Pixel tracking code |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "636f0d682b74aa4017606d52",
"storeFbPixel": "fb_pixel"
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-pixel',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Facebook Pixel successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-seo Edit
Save/Update store SEO description
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| storeSeo | string | Yes | PAID FEATURE Updated store SEO description |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"storeSeo": "seo_description"
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-seo',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "SEO successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-cookie-policy Edit
Save/Update store cookie policy
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| cookiePolicy | boolean | Yes | Cookie policy flag value |
| cookiePolicyTheme | string | Yes | Cookie policy theme, either light or dark theme |
| privacyPolicyLink | string | Yes | Cookie privacy policy link |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"cookiePolicy": true,
"cookiePolicyTheme": "dark",
"privacyPolicyLink": "privacyPolicyLink"
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-cookie-policy',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Settings successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-google-tracking-code Edit
Save/Update store Google tracking code
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| googleTrackingCode | string | Yes | PAID FEATURE Updated Google tracking code |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"googleTrackingCode": "googleTrackingCode",
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-google-tracking-code',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Settings successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-select-location Edit
Save/Update requiring customer to select store location.
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| requireSelectingStoreLocation | boolean | Yes | Flag value to require customer to select store location when purchasing on merchant’s store. |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"googleTrackingCode": "googleTrackingCode",
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-select-location',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Settings successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/convenience-fee Edit
Save/Update store convenience fee
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| convenience_fee | number | Yes | Convenience fee value expressed in percentage. Convenience fee is default to 50% upon store creation |
var axios = require('axios');
var data = JSON.stringify({
"convenience_fee": 50,
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/convenience-fee',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated Convenience Fee Percentage.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-domain Edit
Save/Update store domain
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| storeId | string | Yes | Store id |
| domain | string | Yes | Updated store domain |
| domain_type | string | Yes | Type of domain being supplied, either own_domain or subdomain. own_domain is a PAID FEATURE. |
var axios = require('axios');
var data = JSON.stringify({
"storeId": "63760ee5a3444c4d444c158c",
"domain": "domain_value",
"domain_type": "subdomain",
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-domain',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Settings successfully updated.",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/details Edit
Get store details
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/store/details',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "",
"data": {
"store": {
"additionalFee": 0,
"xenplatform_user_id": "",
"alreadyAvailedPaidPlan": false,
"_id": "63760ee5a3444c4d444c158c",
"storeOwner": "63760ee35f12fa931cbb3dea",
"storeName": "updated_store_name",
"storeAlias": "updatedstorename",
"storeIndustry": "604718297aa0fb376c0fcca9",
"storeSharingPrefixDesc": "",
"storeLogo": "store_logo_url",
"storePrimaryColor": "#d05353",
"storeSecondaryColor": "#000",
"cookiePolicy": true,
"cookiePolicyTheme": "Dark",
"requireSelectingStoreLocation": true,
"shouldSaveFbLead": false,
"isGuestCheckoutVerification": false,
"isStoreEnabled": false,
"isEnabledOnlinePayment": false,
"isVerifiedBankForOnlinePayment": false,
"convenienceFeeSeller": 50,
"convenienceFeeBuyer": 0,
"shippingOptions": {
"STANDARD": null,
"SAMEDAY_SCHED": null,
"OWN_BOOKING": false,
"PICKUP": false
},
"alreadyAvailedPlusPlan": false,
"payPlanType": "PLUS",
"billingType": "NONE",
"billing": {
"free_visitor_limit": 100,
"paid_visitor_limit": 0,
"p1_users": 1,
"paid_p1_users": 0
},
"billingVerificationId": [],
"alreadyClaimedFreeTrial": false,
"redirectToCustomDomain": false,
"redirectToCustomSubDomain": false,
"billingCutOffDate": 17,
"dateCreated": "2022-11-17T10:37:25.120Z",
"lastUpdated": "2022-11-17T10:37:25.121Z",
"storeSlogan": "New slogan",
"facebookLink": "facebook_link",
"instagramLink": "instagram_link",
"linkedinLink": "linkedin_link",
"twitterLink": "twitter_link",
"customSubDomain": "custom_p1_subdomain",
"customDomain": "custom_domain_link",
"fbPixel": "fb_pixel_code",
"googleTrackingCode": "google_tracking_code",
"privacyPolicyLink": "privacy_policy_link",
"updatedAt": "2023-03-26T05:57:13.881Z",
"lastTransaction": "2023-03-26T05:57:13.900Z",
"storeFavicon": "storefavicon_url",
}
}
}
/business-profile/store/update/store-business-operations Edit
Save/update business operations settings
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| business_operation_type | string | Yes | Type of business operation (Possible values: rfq’, ‘add_to_cart’, ‘disabled’) |
| contact_form | string | Yes (for rfq) | Contact form URL. |
| btn_name | string | Yes (for rfq) | Button name request for quotation. |
var axios = require('axios');
var data = JSON.stringify({
"business_operation_type": "rfq",
"contact_form": "https://contact-form.com",
"btn_name": "Request for Quotation",
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/update/store-business-operations',
data: data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Succesfully updated business operations settings.",
"data": null
}
/business-profile/store/additional-fee Edit
Add new additional fee
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| description | string | Yes | Description of the additional fee |
| price | number | Yes | Additional fee amount |
| is_set | boolean | No | Flag used to set as active or not this new additinal fee. |
var axios = require('axios');
var data = JSON.stringify({
"description": "Additional fee description",
"price": 12,
"is_set": false
});
var config = {
method: 'post',
url: 'api.prosperna.com/v1/business-profile/store/additional-fee',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully created additional fee.",
"data": {
"id": "642000041e840f2c62fcbe73",
"description": "Additional fee description",
"price": 12,
"is_set": false
}
}
/business-profile/store/additional-fee Edit
Get all additional fees
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/store/additional-fee',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "",
"data": {
"additional_fees": [
{
"store_id": "639749a5cb1db88617891bf0",
"description": "Additional fee description",
"price": 12,
"is_set": false,
"createdAt": "2023-03-26T08:19:16.731Z",
"updatedAt": "2023-03-26T08:19:16.731Z",
"id": "642000041e840f2c62fcbe73"
}
]
}
}
/business-profile/store/additional-fee/:additional_fee_id Edit
Update additional fee
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| additional_fee_id | string | Yes | Id of the additional fee to be updated |
var axios = require('axios');
var data = JSON.stringify({
"description": "Updated additional fee description",
"price": 23,
"is_set": false
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/additional-fee/641a7ff47f8d70fb9f757509',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated additional fee."
}
/business-profile/store/additional-fee/:additional_fee_id Edit
Delete additional fee
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| additional_fee_id | string | Yes | Id of the additional fee to be deleted |
var axios = require('axios');
var config = {
method: 'delete',
url: 'api.prosperna.com/v1/business-profile/store/additional-fee/641a7ff47f8d70fb9f757509',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully deleted additional fee."
}
/business-profile/store/additional-fee/:additional_fee_id/set Edit
Set as additional fee
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| additional_fee_id | string | Yes | Id of the additional fee to be set as active |
var axios = require('axios');
var config = {
method: 'patch',
url: 'api.prosperna.com/v1/business-profile/store/additional-fee/641a7ff47f8d70fb9f757509/set',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully set additional fee."
}
/business-profile/store/digital-products/payment-settings Edit
Save and update digital product payment settings
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| BANK_TRANSFER | boolean | Yes | Determines if bank transfer is accepted as payment option for digital products purchases. |
| E_WALLET | boolean | Yes | Determines if e-wallet is accepted as payment option for digital products purchases. |
| CREDIT_CARD | boolean | Yes | Determines if credit card is accepted as payment option for digital products purchases. |
| OVER_THE_COUNTER | boolean | Yes | Determines if over-the-counter is accepted as payment option for digital products purchases. |
var axios = require('axios');
var data = JSON.stringify({
"BANK_TRANSFER": true,
"E_WALLET": false,
"CREDIT_CARD": true,
"OVER_THE_COUNTER": true
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/store/digital-products/payment-settings',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated digital product payment settings.",
"data": {
"digital_payment_options": {
"store_id": "63760ee5a3444c4d444c158c",
"createdAt": "2023-03-03T03:12:46.392Z",
"payment_options": {
"BANK_TRANSFER": true,
"E_WALLET": false,
"CREDIT_CARD": true,
"OVER_THE_COUNTER": true
},
"updatedAt": "2023-03-26T11:34:38.719Z",
"id": "640165ae27495b7b2574aeaa"
}
}
}
/business-profile/marketplace/apps Edit
Get all marketplace apps on P1 platform
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/marketplace/apps',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve all marketplace apps.",
"data": {
"apps": [
{
"is_activated": true,
"app_key": "jnt",
"title": "app name",
"subtitle": "app subtitle",
"description": "app description",
"icon": "app_icon_url",
"contents": [
{
"title": "Overview",
"key": "overview",
"carousel": [
"image_1.png",
"image_2.png"
],
"description": "description",
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409215"
},
],
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409214"
}
]
}
}
/business-profile/marketplace/my-apps/:app_key/activate Edit
Activate/Install an app to your store
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| app_key | string | Yes | The app key of marketplace app you want to activate/install. |
var axios = require('axios');
var config = {
method: 'post',
url: 'api.prosperna.com/v1/business-profile/marketplace/my-apps/jnt/activate',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve all installed marketplace apps.",
"data": {
"my_apps": {
"activated_apps": {
"is_activated": true,
"app_key": "jnt",
"title": "app name",
"subtitle": "app subtitle",
"description": "app description",
"icon": "app_icon_url",
"contents": [
{
"title": "Overview",
"key": "overview",
"carousel": [
"image_1.png",
"image_2.png"
],
"description": "description",
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409215"
},
],
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409214"
}
}
}
}
}
/business-profile/marketplace/my-apps Edit
Get all activated/installed apps on your store
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/marketplace/my-apps',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve all installed marketplace apps.",
"data": {
"my_apps": [
{
"is_activated": true,
"app_key": "jnt",
"title": "app name",
"subtitle": "app subtitle",
"description": "app description",
"icon": "app_icon_url",
"contents": [
{
"title": "Overview",
"key": "overview",
"carousel": [
"image_1.png",
"image_2.png"
],
"description": "description",
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409215"
},
],
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409214"
}
]
}
}
/business-profile/marketplace/apps/:app_key Edit
Get single marketplace app on P1 platform
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| app_key | string | Yes | Marketplace app key |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/marketplace/apps/jnt',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully retrieve marketplace app details",
"data": {
"app_details":
{
"is_activated": true,
"app_key": "jnt",
"title": "app name",
"subtitle": "app subtitle",
"description": "app description",
"icon": "app_icon_url",
"contents": [
{
"title": "Overview",
"key": "overview",
"carousel": [
"image_1.png",
"image_2.png"
],
"description": "description",
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409215"
},
],
"createdAt": "2023-01-05T08:53:49.092Z",
"updatedAt": "2023-01-05T08:53:49.092Z",
"id": "63b6901d491f6be12b409214"
}
}
}
/business-profile/shipping/settings/:store_id Edit
Get all activated shippings for a given store
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/store/details',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "",
"data": {
"shippingDetails": [
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "PICKUP",
"shipping_option_type": "PICKUP",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-08T02:28:16.886Z",
"updatedAt": "2022-12-08T03:01:31.355Z",
"id": "63914bc0ae4193caaf9c179d",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "OWN_BOOKING",
"shipping_option_type": "OWN_BOOKING",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-08T03:03:58.344Z",
"updatedAt": "2022-12-09T14:33:35.490Z",
"id": "6391541e1db2f7242fd1e4ba",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "6395af15cb1db8861788ad22",
"shipping_option": "J&T",
"shipping_option_type": "STANDARD",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": true,
"CREDIT_CARD": true,
"OVER_THE_COUNTER": true
},
"createdAt": "2022-12-09T13:49:46.701Z",
"updatedAt": "2022-12-11T10:21:23.770Z",
"id": "63933cfa669bf24320a29815",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "LALAMOVE",
"shipping_option_type": "SAMEDAY_SCHED",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-09T14:12:12.165Z",
"updatedAt": "2022-12-09T14:12:12.165Z",
"id": "6393423cb49cfd9aad9eeb14",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
}
]
}
}
/business-profile/shipping/settings/:store_id?shipping_type_option= Edit
Get shipping setting details
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Query Parameters | Data Type | Required | Description |
| shipping_type_option | string | Yes | Shipping type option. Values are OWN_BOOKING, SAMEDAY_SCHED, STANDARD, PICKUP |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/shipping/settings/63861440e2c90910a117e826?shipping_type_option=STANDARD',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "",
"data": {
"shippingDetails": [
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "PICKUP",
"shipping_option_type": "PICKUP",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-08T02:28:16.886Z",
"updatedAt": "2022-12-08T03:01:31.355Z",
"id": "63914bc0ae4193caaf9c179d",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "OWN_BOOKING",
"shipping_option_type": "OWN_BOOKING",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-08T03:03:58.344Z",
"updatedAt": "2022-12-09T14:33:35.490Z",
"id": "6391541e1db2f7242fd1e4ba",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "6395af15cb1db8861788ad22",
"shipping_option": "J&T",
"shipping_option_type": "STANDARD",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": true,
"CREDIT_CARD": true,
"OVER_THE_COUNTER": true
},
"createdAt": "2022-12-09T13:49:46.701Z",
"updatedAt": "2022-12-11T10:21:23.770Z",
"id": "63933cfa669bf24320a29815",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
},
{
"pickup_address": "63908c8b5e8aa33cd37b9e77",
"shipping_option": "LALAMOVE",
"shipping_option_type": "SAMEDAY_SCHED",
"selected": true,
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"createdAt": "2022-12-09T14:12:12.165Z",
"updatedAt": "2022-12-09T14:12:12.165Z",
"id": "6393423cb49cfd9aad9eeb14",
"pickup_details": {
"_id": "63908c8b5e8aa33cd37b9e77",
"store_id": "63861440e2c90910a117e826",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save address",
"province": {
"name": "province_name",
"id": "province_id"
},
"barangay": {
"name": "barangay_name",
"id": "barangay_id"
},
"city": {
"name": "city_name",
"id": "city_id"
},
"createdAt": "2022-12-07T12:52:27.162Z",
"updatedAt": "2022-12-07T12:53:38.519Z",
"__v": 0
}
}
]
}
}
/business-profile/shipping/settings/:store_id Edit
Save/update shipping setting of a given store
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Request Body | Data Type | Required | Description |
| shipping_option | string | Yes | Shipping provider. Values are OWN_BOOKING, LALAMOVE, LBC, PICKUP, J&T |
| payment_options.BANK_TRANSFER | boolean | Yes | Determines if bank transfer is enabled for a given shipping option. |
| payment_options.COD | boolean | Yes | Determines if cash-on-delivery is enabled for a given shipping option. |
| payment_options.E_WALLET | boolean | Yes | Determines if e-wallet payment is enabled for a given shipping option. |
| payment_options.CREDIT_CARD | boolean | Yes | Determines if credit card payment is enabled for a given shipping option. |
| payment_options.OVER_THE_COUNTER | boolean | Yes | Determines if over-the-counter payment is enabled for a given shipping option. |
| pickup_address | string | Yes | Pickup address id. |
var axios = require('axios');
var data = JSON.stringify({
"shipping_option": "LBC",
"payment_options": {
"BANK_TRANSFER": true,
"COD": true,
"COP": false,
"E_WALLET": false,
"CREDIT_CARD": false,
"OVER_THE_COUNTER": false
},
"pickup_address": "63989075f681e6a270814754"
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/shipping/settings/6386ae5dba4bf984402d848e',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated shipping settings."
}
/business-profile/shipping/settings/:store_id/toggle?shipping_type_option= Edit
Toggle on and off shipping setting
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Query Parameters | Data Type | Required | Description |
| shipping_type_option | string | Yes | Shipping type option. Values are OWN_BOOKING, SAMEDAY_SCHED, STANDARD, PICKUP |
var axios = require('axios');
var config = {
method: 'patch',
url: 'api.prosperna.com/v1/business-profile/shipping/settings/63861440e2c90910a117e826/toggle?shipping_type_option=SAMEDAY_SCHED',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated shipping settings."
}
/business-profile/shipping/settings/:store_id/guest-checkout-verification Edit
Toggle on and off guest checkout verification
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
var axios = require('axios');
var config = {
method: 'patch',
url: 'api.prosperna.com/v1/business-profile/shipping/settings/63861440e2c90910a117e826/guest-checkout-verification',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated shipping settings."
}
/business-profile/shipping/:store_id Edit
Add new pickup address
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Request Body | Data Type | Required | Description |
| barangay.id | string | Yes | Barangay id |
| barangay.name | string | Yes | Barangay name |
| province.id | string | Yes | Province id |
| province.name | string | Yes | Province name |
| city.id | string | Yes | City id |
| city.name | string | Yes | City name |
| contact_number | string | Yes | Contact number |
| contact_person | string | Yes | Contact person |
| business_address | string | Yes | Business address |
| save_address_name | string | Yes | Save address name |
| coordinates.lat | number | Yes, if LALAMOVE will be used | Latitude coordinates |
| coordinates.long | number | Yes, if LALAMOVE will be used | Longitude coordinates |
var axios = require('axios');
var data = JSON.stringify({
"barangay": {
"id": "",
"name": ""
},
"province": {
"id": "",
"name": ""
},
"city": {
"id": "",
"name": ""
},
"contact_number": "contact_number",
"contact_person": "contact_person",
"business_address": "business_address",
"save_address_name": "save_address_name"
});
var config = {
method: 'post',
url: 'api.prosperna.com/v1/business-profile/shipping/63988d50710a9e5920f87b68',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully added pickup address.",
"data": {
"address": {
"store_id": "63988d50710a9e5920f87b68",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save_address_name",
"province": {
"name": "",
"id": ""
},
"barangay": {
"name": "",
"id": ""
},
"city": {
"name": "",
"id": ""
},
"createdAt": "2023-03-26T13:24:26.597Z",
"updatedAt": "2023-03-26T13:24:26.597Z",
"id": "6420478a1e840f2c62fcbf08"
}
}
}
/business-profile/shipping/:store_id/pickup-address/:pickup_address_id Edit
Delete pickup address
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| pickup_address_id | string | Yes | Pickup address id |
var axios = require('axios');
var config = {
method: 'delete',
url: 'api.prosperna.com/v1/business-profile/shipping/639749a5cb1db88617891bf1/pickup-address/63d26a14a254f44dbf2fce3c',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully deleted pickup address.",
}
/business-profile/shipping/:store_id Edit
Get all pickup address per store
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/shipping/639749a5cb1db88617891bc2',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "ok",
"data": {
"address": [
{
"store_id": "639749a5cb1db88617891bc2",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save_address_name",
"province": {
"name": "",
"id": ""
},
"barangay": {
"name": "",
"id": ""
},
"city": {
"name": "",
"id": ""
},
"coordinates": {
"long": 121.1250825,
"lat": 14.1876712
},
"createdAt": "2023-01-26T11:55:00.754Z",
"updatedAt": "2023-01-26T11:55:00.754Z",
"id": "63d26a14a254f44dbf2fce3a"
},
]
}
}
/business-profile/shipping/:store_id?pickup_address_id= Edit
Get all pickup address per store
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Query parameters | Data Type | Required | Description |
| pickup_address_id | string | Yes | Pickup address id |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/business-profile/shipping/:store_id?pickup_address_id=63908c8b5e8aa33cd37b9e77',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "ok",
"data": {
"address": [
{
"store_id": "639749a5cb1db88617891bc2",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save_address_name",
"province": {
"name": "",
"id": ""
},
"barangay": {
"name": "",
"id": ""
},
"city": {
"name": "",
"id": ""
},
"coordinates": {
"long": 121.1250825,
"lat": 14.1876712
},
"createdAt": "2023-01-26T11:55:00.754Z",
"updatedAt": "2023-01-26T11:55:00.754Z",
"id": "63d26a14a254f44dbf2fce3a"
},
]
}
}
/business-profile/shipping/:store_id/pickup-address/:pickup_address_id Edit
Add new pickup address
| Request parameters | Data Type | Required | Description |
|---|---|---|---|
| store_id | string | Yes | Store id |
| Request Body | Data Type | Required | Description |
| barangay.id | string | Yes | Barangay id |
| barangay.name | string | Yes | Barangay name |
| province.id | string | Yes | Province id |
| province.name | string | Yes | Province name |
| city.id | string | Yes | City id |
| city.name | string | Yes | City name |
| contact_number | string | Yes | Contact number |
| contact_person | string | Yes | Contact person |
| business_address | string | Yes | Business address |
| save_address_name | string | Yes | Save address name |
| coordinates.lat | number | Yes, if LALAMOVE will be used | Latitude coordinates |
| coordinates.long | number | Yes, if LALAMOVE will be used | Longitude coordinates |
var axios = require('axios');
var data = JSON.stringify({
"barangay": {
"id": "",
"name": ""
},
"province": {
"id": "",
"name": ""
},
"city": {
"id": "",
"name": ""
},
"contact_number": "contact_number",
"contact_person": "contact_person",
"business_address": "business_address",
"save_address_name": "save_address_name"
});
var config = {
method: 'put',
url: 'api.prosperna.com/v1/business-profile/shipping/63861440e2c90910a117e826/pickup-address/63908c8b5e8aa33cd37b9e77',
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Successfully updated pickup address.",
"data": {
"address": {
"store_id": "63988d50710a9e5920f87b68",
"contact_person": "contact_person",
"contact_number": "contact_number",
"business_address": "business_address",
"save_address_name": "save_address_name",
"province": {
"name": "",
"id": ""
},
"barangay": {
"name": "",
"id": ""
},
"city": {
"name": "",
"id": ""
},
"createdAt": "2023-03-26T13:24:26.597Z",
"updatedAt": "2023-03-26T13:24:26.597Z",
"id": "6420478a1e840f2c62fcbf08"
}
}
}
/email/billing/plan-change Edit
Send plan change billing emails
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| merchant_name | string | Yes | The name of the merchant. |
| merchant_email | string | Yes | The email of the merchant. |
| subject | string | Yes | The subject of the email. |
| plan_expiration_date | string | Yes | The expiration date of the subscription plan. |
| plan_action | string | Yes | The action to be taken regarding the subscription plan. Possible values: plan_upgrade, plan_renew, plan_change |
| billing_url | string | Yes | The URL link to the billing or invoice page. |
| current_plan | string | Yes | The current subscription plan. Possible values: FREE, PLUS, PRO, PREMIUM, PREMIUM TRIAL |
| previous_plan | string | Yes | The previous subscription plan. Possible values: FREE, PLUS, PRO, PREMIUM, PREMIUM TRIAL |
| billing_type | string | Yes | The type of billing. Possible values: MONTHLY, QUARTERLY, ANNUAL |
var axios = require('axios');
var config = {
method: 'post',
url: 'api.prosperna.com/v1/email/billing/plan-change',
data: {
merchant_name: 'merchant_name',
merchant_email: 'merchant@example.com',
subject: 'Your Email Subject',
plan_expiration_date: '2023-12-31',
plan_action: 'plan_upgrade',
billing_url: 'https://p1.prosperna.com/home/billing?tab=invoices',
current_plan: 'PRO',
previous_plan: 'FREE',
billing_type: 'MONTHLY'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Ok",
"data": null
}
/email/billing/plan-expiration Edit
Send plan expiring billing emails for EWALLET
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| merchant_name | string | Yes | The name of the merchant. |
| merchant_email | string | Yes | The email of the merchant. |
| subject | string | Yes | The subject of the email. |
| plan_expiration_date | string | Yes | The expiration date of the subscription plan. |
| plan_action | string | Yes | The action to be taken regarding the subscription plan. Possible values: plan_upgrade, plan_renew, plan_change |
| billing_url | string | Yes | The URL link to the billing or invoice page. |
| current_plan | string | Yes | The current subscription plan. Possible values: FREE, PLUS, PRO, PREMIUM, PREMIUM TRIAL |
| previous_plan | string | Yes | The previous subscription plan. Possible values: FREE, PLUS, PRO, PREMIUM, PREMIUM TRIAL |
| billing_type | string | Yes | The type of billing. Possible values: MONTHLY, QUARTERLY, ANNUAL |
| days_remaining | number | Yes | Number of days remaining before plan expiration. |
var axios = require('axios');
var config = {
method: 'post',
url: 'api.prosperna.com/v1/email/billing/plan-change',
data: {
merchant_name: 'merchant_name',
merchant_email: 'merchant@example.com',
subject: 'Your Email Subject',
plan_expiration_date: '2023-12-31',
plan_action: 'plan_upgrade',
billing_url: 'https://p1.prosperna.com/home/billing?tab=invoices',
current_plan: 'PRO',
previous_plan: 'FREE',
billing_type: 'MONTHLY',
days_remaining: 0
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"success": true,
"message": "Ok",
"data": null
}
payments/balances/merchants/send-otp Edit
Send OTP
var axios = require('axios');
var config = {
method: 'put',
url: 'api.prosperna.com/v1/payments/balances/merchants/send-otp',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"statusCode": 200,
"message": "Successfully sent otp code.",
"data": {
"valid_until:"2023-12-31T23:59:59.999Z",
"mobile_number": "+639658745878"
"is_valid_otp": true,
"remaining_otp_resends": 2
}
}
payments/balances/merchants/withdraw Edit
Withdraw balances
| Request Body | Data Type | Required | Description |
|---|---|---|---|
| amount | number | Yes | Withdrawal amount, limits to Php250 minimum and Php50000 maximum per transaction. |
| otp_code | number | Yes | Valid OTP code sent to merchant’s mobile number. |
var axios = require('axios');
var config = {
method: 'post',
url: 'api.prosperna.com/v1/payments/balances/merchants/withdraw',
data: {
"amount": 1000,
"otp_code": 123456
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"statusCode": 200,
"message": "Your available balance of PhP 1000.00 has been withdrawn. The funds may reflect in your account in "real-time" or within 3 business days, depending on the financial institution you have chosen for settlement.",
"data": {
"amount": 1000,
"withdrawal_amount": 970,
"admin_fee": 30,
"expected_arrival:"2023-12-31T23:59:59.999Z"
}
}
payments/balances/merchants Edit
Get balances breakdown
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/payments/balances/merchants'
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"statusCode": 200,
"message": "",
"data": {
"available_balance": 5000,
"pending_balance": 0,
"lifetime_orders": 5000,
"total_withdrawal_history: 0
}
}
payments/balances/merchants/order-breakdowns Edit
Get payment order breakdowns
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| balance_type | string | Yes | Type of balance to be queried, values must be either ‘pending_order’ or ‘lifetime_orders’ |
| min_date | Date | No | Minimum date filter. |
| max_date | Date | No | Maximum date filter. |
| search | string | No | Search filter for order id. |
| page | number | No | Page for pagination. |
| limit | number | No | Number of records per page. |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.comv1/payments/balances/merchants/order-breakdowns?balance_type=pending_orders&min_date=2023-06-17&max_date=2023-06-17&search=&page=1&limit=10',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"statusCode": 200,
"message": "",
"data": {
"order_breakdowns": [
{
"order_id": "65241f47500c18505c900333",
"store_id": "639749a5cb1db88617891333",
"customer_name": "Merchant name",
"payment_type": "CREDIT_CARD",
"shipping_type": "Same Day",
"amount": 268.45,
"order_payment_date": "2023-10-09T15:42:00.865Z"
}
],
"pagination": {
"totalDocs": 2,
"limit": 10,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}
}
}
payments/balances/merchants/withdrawal-history Edit
Get merchant withdrawal histories
| Query Parameters | Data Type | Required | Description |
|---|---|---|---|
| min_date | Date | No | Minimum date filter. |
| max_date | Date | No | Maximum date filter. |
| search | string | No | Search filter for amount, bank name, transaction id, reference id and status. |
| bank | string | No | Filter by bank. Valid bank names are ‘UNIONBANK’, ‘BDO’, ‘BPI’, and ‘GCASH’. |
| status | string | No | Filter by status. Valid status are ‘Completed’, ‘Pending’, ‘Cancelled’, ‘Failed’, ‘Disputed’. |
| page | number | No | Page for pagination. |
| limit | number | No | Number of records per page. |
var axios = require('axios');
var config = {
method: 'get',
url: 'api.prosperna.com/v1/payments/balances/merchants/withdrawal-history?page=2&limit=56&search=&min_date=2023-04-23&max_date=2023-04-26&status=Completed&bank=BPI',
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"statusCode": 200,
"message": "",
"data": {
"withdrawal_history": [
{
"transaction_counter": 30,
"transaction_id": "disb-5e718a53-3f02-4d7c-80f8-33333333333",
"reference_id": "P1-DISBURSE-602c3afd-7929-4885-a22f-33333333333",
"withdrawal_date": "2023-09-01T05:09:10.437Z",
"expected_arrival": "2023-09-04T05:09:10.437Z",
"withdrawal_amount": 1000,
"bank_name": "UNIONBANK",
"account_number": "6**************2",
"status": "Completed",
"id": "64f171f63ce0beff8705b333",
"store_id": "639749a5cb1db88617891333"
},
],
"pagination": {
"totalDocs": 2,
"limit": 10,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}
}
}