Skip to main content

Clover API Endpoints

Updated over 3 weeks ago

Base URLs:

Table of Contents

Customer Endpoints

Get a Customer: (GET)

[Base URL]/ customers/{Id}?expand=addresses%2CemailAddresses%2CphoneNumbers%2Cmetadata

Create a Customer: (POST)

[Base URL]/customers?expand=addresses

Update a Customer: (PUT)

[Base URL]/customers{Id}

Customer Address Endpoints

Create a Customer Address: (POST)

[Base URL]/customers/{id}/addresses

Update a Customer Address: (PUT)

[Base URL]/customers/{id}/addresses

Product Endpoints

Create an Item: (POST)

[Base URL]/items

Create an item group: (POST)

[Base URL]/item_groups

Create a Product Inventory: (POST)

[Base URL]/item_stocks/{ProductId}

Update a Product Inventory: (PUT)

[Base URL]/item_stocks/{ProductId}

Get Product Attributes: (GET)

[Base URL]/attributes?filter=itemGroup.id={itemGroupIdForOption}

Create a Product Attributes: (POST)

[Base URL]/attributes

Get Product Option by Attribute Id: (GET)

[Base URL]/attributes/{AttributeId}/options

Create a Product Option: (POST)

[Base URL]/attributes/{AttributeId}/options

Product Variant Endpoints

Create a Variant: (POST)

[Base URL]/items

Update a Variant: (PUT)

[Base URL]/items{id}

Create a Product Variant Inventory: (POST)

[Base URL]/item_stocks/{ProductId}

Update a Product Variant Inventory: (PUT)

[Base URL]/item_stocks/{ProductId}

Get Product Variant Option by Attribute Id: (GET)

[Base URL]/attributes/{AttributeId}/options

Create a Product Variant Option: (POST)

[Base URL]/attributes/{AttributeId}/options

Transaction Endpoints

Get an Order: (GET)

[Base URL]/orders/?filter=title={searchId}&expand=payments%2ClineItems%2Ccustomers%2Ccustomers.emailAddresses

Get an Order Payment: (GET)

[Base URL] orders/{id}?expand=payments%2ClineItems%2ClineItems.taxRates%2Ccustomers%2Ccustomers.emailAddresses

Create an Order: (POST)

[Base URL]/orders

Update an Order: (PUT)

[Base URL]/orders{Id}

Transaction Address Endpoints

Get an Order Address: (GET)

[Base URL]/address

Transaction Line Endpoints

Get an Order Line: (GET)

[Base URL]/orders/{Id}

Create an Order: (POST)

[Base URL]/orders/{id}/bulk_line_items
Did this answer your question?