storefront.md

Storefront

A collection of endpoints for creating and managing storefronts

Methods

Method	HTTP	Path	Summary
add_products	POST	/storefront/{id}/product	Add Products to Storefront
create	POST	/storefront	Create Storefront
delete	DELETE	/storefront/{id}	Delete Storefront
duplicate	POST	/storefront/{id}/duplicate	Duplicate Storefront
fetch	GET	/storefront/{id}	Fetch Storefront
fetch_orders	GET	/storefront/{id}/order	Fetch Storefront Orders
list	GET	/storefront	List Storefronts
list_products	GET	/storefront/{id}/product	List Storefront Products
publish	POST	/storefront/{id}/publish	Publish Storefront
update	PUT	/storefront/{id}	Update Storefront
verify_slug	GET	/storefront/verify/{slug}	Verify Storefront Slug

---

add_products

HTTP: POST
Path: /storefront/{id}/product

paystack.storefront.add_products(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
products	true

create

HTTP: POST
Path: /storefront

paystack.storefront.create({ ... })

Body Fields

Name	Required
name	true
slug	true
currency	true
description	false

delete

HTTP: DELETE
Path: /storefront/{id}

paystack.storefront.delete(id)

Path Parameters

Name	Required
id	true

duplicate

HTTP: POST
Path: /storefront/{id}/duplicate

paystack.storefront.duplicate(id)

Path Parameters

Name	Required
id	true

fetch

HTTP: GET
Path: /storefront/{id}

paystack.storefront.fetch(id)

Path Parameters

Name	Required
id	true

fetch_orders

HTTP: GET
Path: /storefront/{id}/order

paystack.storefront.fetch_orders(id)

Path Parameters

Name	Required
id	true

list

HTTP: GET
Path: /storefront

paystack.storefront.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
status	false

list_products

HTTP: GET
Path: /storefront/{id}/product

paystack.storefront.list_products(id)

Path Parameters

Name	Required
id	true

publish

HTTP: POST
Path: /storefront/{id}/publish

paystack.storefront.publish(id)

Path Parameters

Name	Required
id	true

update

HTTP: PUT
Path: /storefront/{id}

paystack.storefront.update(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
name	false
slug	false
description	false

verify_slug

HTTP: GET
Path: /storefront/verify/{slug}

paystack.storefront.verify_slug(slug)

Path Parameters

Name	Required
slug	true