/loyverse | Type: Application | PCID required: Yes
Tools
loyverse_create_categories
Create or update a single category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
color | string | No | — | The color value |
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
id | string | No | — | The category id. If included in the POST request it will cause an update instead of a creating a new object. |
name | string | Yes | — | The name value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"color": {
"type": "string",
"description": "The color value",
"enum": [
"GREY",
"RED",
"PINK",
"ORANGE",
"GREEN",
"BLUE",
"PURPLE"
]
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"id": {
"type": "string",
"description": "The category id. If included in the POST request it will cause an update instead of a creating a new object."
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"name"
]
}
loyverse_create_customers
Create or update a single customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | No | — | The customer’s address |
city | string | No | — | The customer’s city, town, or village. |
country_code | string | No | — | The two-letter country code corresponding to the customer’s country in ISO 3166-1-alpha-2 format. |
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
customer_code | string | No | — | Customer Code |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
email | string | No | — | The customer’s email |
first_visit | string | No | — | The date of the first customer visit |
id | string | No | — | The customer id. If included in the POST request it will cause an update instead of a creating a new object. |
last_visit | string | No | — | The date of the most recent customer visit |
name | string | Yes | — | The customer’s name |
note | string | No | — | The note about the customer |
permanent_deletion_at | string | No | — | The time when the customer data will be permanently deleted (usually 24 hours after soft deletion) |
phone_number | string | No | — | The customer’s phone number |
postal_code | string | No | — | The customer’s postal code, also known as zip, postcode, Eircode, etc. |
region | string | No | — | The customer’s region name. Typically a province, a state, or a prefecture. |
total_points | number | No | — | Actual customer points balance |
total_spent | number | No | — | The total money amount that customer had spent |
total_visits | integer | No | — | The total number of visits |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "string",
"description": "The customer's address"
},
"city": {
"type": "string",
"description": "The customer's city, town, or village."
},
"country_code": {
"type": "string",
"description": "The two-letter country code corresponding to the customer's country in ISO 3166-1-alpha-2 format."
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"customer_code": {
"type": "string",
"description": "Customer Code"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"email": {
"type": "string",
"description": "The customer's email"
},
"first_visit": {
"type": "string",
"description": "The date of the first customer visit"
},
"id": {
"type": "string",
"description": "The customer id. If included in the POST request it will cause an update instead of a creating a new object."
},
"last_visit": {
"type": "string",
"description": "The date of the most recent customer visit"
},
"name": {
"type": "string",
"description": "The customer's name"
},
"note": {
"type": "string",
"description": "The note about the customer"
},
"permanent_deletion_at": {
"type": "string",
"description": "The time when the customer data will be permanently deleted (usually 24 hours after soft deletion)"
},
"phone_number": {
"type": "string",
"description": "The customer's phone number"
},
"postal_code": {
"type": "string",
"description": "The customer’s postal code, also known as zip, postcode, Eircode, etc."
},
"region": {
"type": "string",
"description": "The customer’s region name. Typically a province, a state, or a prefecture."
},
"total_points": {
"type": "number",
"description": "Actual customer points balance"
},
"total_spent": {
"type": "number",
"description": "The total money amount that customer had spent"
},
"total_visits": {
"type": "integer",
"description": "The total number of visits"
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
}
},
"required": [
"PCID",
"name"
]
}
loyverse_create_discounts
Create or update a single discount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
discount_amount | number | No | — | The discount value in money representation (only for discounts with type FIXED_AMOUNT) |
discount_percent | number | No | — | This is discount value in percentage (only for discounts with type FIXED_PERCENT) |
id | string | No | — | The discount id. If included in the POST request it will cause an update instead of a creating a new object. |
name | string | Yes | — | The discount name |
restricted_access | boolean | No | — | If true, the password verification is necessary in order to apply this discount on POS. |
stores | string[] | No | — | The list of store ids where this discount is available. By default discount is available at all stores |
type | string | Yes | — | The type of the discount |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"discount_amount": {
"type": "number",
"description": "The discount value in money representation (only for discounts with type FIXED_AMOUNT)"
},
"discount_percent": {
"type": "number",
"description": "This is discount value in percentage (only for discounts with type FIXED_PERCENT)"
},
"id": {
"type": "string",
"description": "The discount id. If included in the POST request it will cause an update instead of a creating a new object."
},
"name": {
"type": "string",
"description": "The discount name"
},
"restricted_access": {
"type": "boolean",
"description": "If true, the password verification is necessary in order to apply this discount on POS."
},
"stores": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of store ids where this discount is available. By default discount is available at all stores"
},
"type": {
"type": "string",
"description": "The type of the discount",
"enum": [
"FIXED_PERCENT",
"FIXED_AMOUNT",
"VARIABLE_PERCENT",
"VARIABLE_AMOUNT",
"DISCOUNT_BY_POINTS"
]
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
}
},
"required": [
"PCID",
"name",
"type"
]
}
loyverse_create_items
Create or update a single item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | string | No | — | The category id of the item |
color | string | No | — | One of the predefined colors for the item that is displayed on the POS |
components | object[] | No | — | The list of components for the item. Learn more |
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
description | string | No | — | The item description. |
form | string | No | — | The visual form of the item that is displayed on the POS |
handle | string | No | — | The handle value |
id | string | No | — | Read-only internal id of the item. If included in the POST request it will cause an update instead of a creating a new object. |
image_url | string | No | — | Image Url |
is_composite | boolean | No | — | If true, the item contains a specified quantity of other items. Learn more |
item_name | string | Yes | — | The item name. |
modifiers_ids | string[] | No | — | The list of modifiers ids applied to this item |
option1_name | string | No | — | The name of the first option (for example “Size”). Learn more |
option2_name | string | No | — | The name of the first option (for example “Color”). Learn more |
option3_name | string | No | — | The name of the first option (for example “Material”). Learn more |
primary_supplier_id | string | No | — | Primary Supplier Id |
reference_id | string | No | — | External reference id for the item |
sold_by_weight | boolean | No | — | If true, a fractional quantity for this item can be specified at the time of a sale (for example 1.5) |
tax_ids | string[] | No | — | The list of tax ids applied to this item |
track_stock | boolean | No | — | If true, the system tracks inventory for this item at all stores. Make sure you don’t accidentally disable track stock. If you set track_stock to false then all inventory levels of this item are set to 0 |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
use_production | boolean | No | — | If true, the system tracks stock not only for its components but also for this item. This property can be set only for composite items. Learn more |
variants | any[] | No | — | The variants value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category_id": {
"type": "string",
"description": "The category id of the item"
},
"color": {
"type": "string",
"description": "One of the predefined colors for the item that is displayed on the POS",
"enum": [
"GREY",
"RED",
"PINK",
"ORANGE",
"YELLOW",
"GREEN",
"BLUE",
"PURPLE"
]
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "string",
"format": "uuid",
"description": "Variant Id"
},
"quantity": {
"type": "number",
"description": "The quantity value"
}
}
},
"description": "The list of components for the item. [Learn more](https://help.loyverse.com/help/how-create-composite-item)"
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"description": {
"type": "string",
"description": "The item description."
},
"form": {
"type": "string",
"description": "The visual form of the item that is displayed on the POS",
"enum": [
"SQUARE",
"CIRCLE",
"SUN",
"OCTAGON"
]
},
"handle": {
"type": "string",
"description": "The handle value"
},
"id": {
"type": "string",
"description": "Read-only internal id of the item. If included in the POST request it will cause an update instead of a creating a new object."
},
"image_url": {
"type": "string",
"description": "Image Url"
},
"is_composite": {
"type": "boolean",
"description": "If true, the item contains a specified quantity of other items. [Learn more](https://help.loyverse.com/help/how-create-composite-item)"
},
"item_name": {
"type": "string",
"description": "The item name."
},
"modifiers_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of modifiers ids applied to this item"
},
"option1_name": {
"type": "string",
"description": "The name of the first option (for example \"Size\"). [Learn more](https://help.loyverse.com/help/how-use-variants-items)"
},
"option2_name": {
"type": "string",
"description": "The name of the first option (for example \"Color\"). [Learn more](https://help.loyverse.com/help/how-use-variants-items)"
},
"option3_name": {
"type": "string",
"description": "The name of the first option (for example \"Material\"). [Learn more](https://help.loyverse.com/help/how-use-variants-items)"
},
"primary_supplier_id": {
"type": "string",
"description": "Primary Supplier Id"
},
"reference_id": {
"type": "string",
"description": "External reference id for the item"
},
"sold_by_weight": {
"type": "boolean",
"description": "If true, a fractional quantity for this item can be specified at the time of a sale (for example 1.5)"
},
"tax_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The list of tax ids applied to this item"
},
"track_stock": {
"type": "boolean",
"description": "If true, the system tracks inventory for this item at all stores. Make sure you don't accidentally disable track stock. If you set `track_stock` to false then all inventory levels of this item are set to 0"
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
},
"use_production": {
"type": "boolean",
"description": "If true, the system tracks stock not only for its components but also for this item. This property can be set only for composite items. [Learn more](https://help.loyverse.com/help/how-work-production)"
},
"variants": {
"type": "array",
"description": "The variants value"
}
},
"required": [
"PCID",
"item_name"
]
}
loyverse_create_modifiers
Create or update a single modifier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
id | string | No | — | The modifier id. If included in the POST request it will cause an update instead of a creating a new object. |
modifier_options | object[] | Yes | — | The list of modifier options |
name | string | Yes | — | The modifier name |
position | integer | No | — | Determines the position of this modifier in the modifiers list |
stores | string[] | No | — | The list of store ids where this modifier is available |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"id": {
"type": "string",
"description": "The modifier id. If included in the POST request it will cause an update instead of a creating a new object."
},
"modifier_options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The option modifier id"
},
"name": {
"type": "string",
"description": "The option modifier name"
},
"price": {
"type": "number",
"description": "The option modifier price"
},
"position": {
"type": "integer",
"description": "Determines the position ot this modifier option in the modifier options list"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
}
},
"required": [
"name"
]
},
"description": "The list of modifier options"
},
"name": {
"type": "string",
"description": "The modifier name"
},
"position": {
"type": "integer",
"description": "Determines the position of this modifier in the modifiers list"
},
"stores": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of store ids where this modifier is available"
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
}
},
"required": [
"PCID",
"modifier_options",
"name"
]
}
loyverse_create_pos_devices
Create or update a single pos device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
activated | boolean | No | — | Shows the status of the POS device. If true, this device is connected to the physical device. |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
id | string | No | — | The pos device id. If included in the POST request it will cause an update instead of a creating a new object. |
name | string | Yes | — | The name value |
store_id | string | Yes | — | The store id this device is connected to |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"activated": {
"type": "boolean",
"description": "Shows the status of the POS device. If true, this device is connected to the physical device."
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"id": {
"type": "string",
"description": "The pos device id. If included in the POST request it will cause an update instead of a creating a new object."
},
"name": {
"type": "string",
"description": "The name value"
},
"store_id": {
"type": "string",
"description": "The store id this device is connected to"
}
},
"required": [
"PCID",
"name",
"store_id"
]
}
loyverse_create_receipts
Create a sales receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | No | — | The customer id associated with the receipt |
employee_id | string | No | — | The employee id associated with the receipt |
line_items | object[] | Yes | — | The line items included in the receipt |
note | string | No | — | The receipt’s note |
order | string | No | — | The order name or number associated with the receipt |
payments | object[] | No | — | The list of payments. There is a restriction that only one payment can be applied to receipt when using POST request. |
receipt_date | string | No | — | By default, it matches the created_at value. You can set receipt_date to the date and time in the past when the receipt was created in another system. This value is used in Loyverse back-office reports. |
source | string | No | — | The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. For receipts created from Loyverse mobile point of sale application the value is “point of sale”. |
store_id | string | Yes | — | The store id associated with the receipt |
total_discounts | object[] | No | — | The list of all discounts applied in the receipt. Discounts can be applied in two scopes, RECEIPT or LINE_ITEM. For discount with LINE_ITEM level you must reference to corresponding discount in every line item where this discount is applied. For discounts with RECEIPT level, line_discount for every line item will be generated automatically. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "The customer id associated with the receipt"
},
"employee_id": {
"type": "string",
"description": "The employee id associated with the receipt"
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "string",
"description": "The variant id for this line item"
},
"quantity": {
"type": "number",
"description": "The number of items that were purchased (or refunded in case of refund)"
},
"price": {
"type": "number",
"description": "The price of one item. It includes taxes which type is INCLUDED. It doesn't include discounts, modifiers and taxes which type is ADDED. By default it is equal to the price of the item variant with specified variant_id."
},
"cost": {
"type": "number",
"description": "The cost of one item at the moment of transaction. By default it is equal to the cost of the item variant with specified variant_id."
},
"line_note": {
"type": "string",
"description": "The line item note"
},
"line_taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the existing tax."
}
}
},
"description": "The list of taxes applied to the line item"
},
"line_discounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the existing discount."
}
}
},
"description": "The list of discounts applied to the line item"
},
"line_modifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"modifier_option_id": {
"type": "string",
"description": "The id of existing modifier option"
},
"price": {
"type": "number",
"description": "The price of the modifier option"
}
}
},
"description": "The list of modifiers applied to the line item"
}
},
"required": [
"quantity",
"variant_id"
]
},
"description": "The line items included in the receipt"
},
"note": {
"type": "string",
"description": "The receipt's note"
},
"order": {
"type": "string",
"description": "The order name or number associated with the receipt"
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payment_type_id": {
"type": "string",
"description": "Payment Type Id"
},
"name": {
"type": "string",
"description": "The name of the payment type"
},
"type": {
"type": "string",
"description": "The type value"
},
"money_amount": {
"type": "number",
"description": "The total money amount of this payment (including tips and surcharge)"
},
"paid_at": {
"type": "string",
"format": "date-time",
"description": "The time when this payment was created"
},
"payment_details": {
"type": "object",
"description": "The payment details for integrated payment types"
}
},
"required": [
"payment_type_id",
"money_amount"
]
},
"description": "The list of payments. There is a restriction that only one payment can be applied to receipt when using POST request."
},
"receipt_date": {
"type": "string",
"description": "By default, it matches the created_at value. You can set receipt_date to the date and time in the past when the receipt was created in another system. This value is used in Loyverse back-office reports."
},
"source": {
"type": "string",
"description": "The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. For receipts created from Loyverse mobile point of sale application the value is \"point of sale\"."
},
"store_id": {
"type": "string",
"description": "The store id associated with the receipt"
},
"total_discounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of existing discount"
},
"scope": {
"type": "string",
"enum": [
"RECEIPT",
"LINE_ITEM"
],
"description": "The level for applying discount. If value is `RECEIPT` than `line_discount` is calculated for every line_item and you don't have to reference this discount in every line_item. If value is `LINE_ITEM` than the discount applies only for line items with a discount reference in their `line_discounts` field."
},
"percentage": {
"type": "number",
"description": "The percentage of the discount. For example value 10.55 corresponds to a percentage of 10.55%. Set this value only for discount with type `VARIABLE_PERCENTAGE`"
},
"money_amount": {
"type": "number",
"description": "The money amount of the discount. Set this value only for discount with type `VARIABLE_AMOUNT` and `DISCOUNT_BY_POINTS`"
}
}
},
"description": "The list of all discounts applied in the receipt. Discounts can be applied in two scopes, RECEIPT or LINE_ITEM. For discount with LINE_ITEM level you must reference to corresponding discount in every line item where this discount is applied. For discounts with RECEIPT level, line_discount for every line item will be generated automatically."
}
},
"required": [
"PCID",
"line_items",
"store_id"
]
}
loyverse_create_receipts_by_receipt_number_refund
Create a refund receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_number | string | Yes | — | The sales receipt number for a refund |
employee_id | string | No | — | The employee id associated with the receipt |
line_items | object[] | Yes | — | The line items included in the refund |
receipt_date | string | No | — | By default, it matches the created_at value (time when receipt was created on the Loyverse server). You can set receipt_date to the value that is equal to the date and time in the past when the refund was created in another system. |
source | string | No | — | The name of the the source this receipt comes from. By default it is the name of the application that created the receipt. |
store_id | string | No | — | The store id associated with the refund receipt. By default, it matches the store id of the sales receipt. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_number": {
"type": "string",
"description": "The sales receipt number for a refund"
},
"employee_id": {
"type": "string",
"description": "The employee id associated with the receipt"
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The line item id from the sales receipt that you want to refund"
},
"quantity": {
"type": "number",
"description": "The number of items to be refunded"
}
},
"required": [
"quantity",
"id"
]
},
"description": "The line items included in the refund"
},
"receipt_date": {
"type": "string",
"description": "By default, it matches the created_at value (time when receipt was created on the Loyverse server). You can set receipt_date to the value that is equal to the date and time in the past when the refund was created in another system."
},
"source": {
"type": "string",
"description": "The name of the the source this receipt comes from. By default it is the name of the application that created the receipt."
},
"store_id": {
"type": "string",
"description": "The store id associated with the refund receipt. By default, it matches the store id of the sales receipt."
}
},
"required": [
"PCID",
"receipt_number",
"line_items"
]
}
loyverse_create_suppliers
Create or update a single supplier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address_1 | string | No | — | The supplier address |
address_2 | string | No | — | The supplier address |
city | string | No | — | The supplier city, town, or village. |
contact | string | No | — | The supplier contact person name |
country_code | string | No | — | The two-letter country code corresponding to the supplier country in ISO 3166-1-alpha-2 format. |
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
email | string | No | — | The supplier email |
id | string | No | — | The supplier id. If included in the POST request it will cause an update instead of a creating a new object. |
name | string | Yes | — | The supplier company name |
note | string | No | — | The note value |
phone_number | string | No | — | Phone Number |
postal_code | string | No | — | The supplier’s postal code, also known as zip, postcode, Eircode, etc. |
region | string | No | — | The supplier’s region name. Typically a province, a state, or a prefecture. |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
website | string | No | — | The supplier website page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address_1": {
"type": "string",
"description": "The supplier address"
},
"address_2": {
"type": "string",
"description": "The supplier address"
},
"city": {
"type": "string",
"description": "The supplier city, town, or village."
},
"contact": {
"type": "string",
"description": "The supplier contact person name"
},
"country_code": {
"type": "string",
"description": "The two-letter country code corresponding to the supplier country in ISO 3166-1-alpha-2 format."
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"email": {
"type": "string",
"description": "The supplier email"
},
"id": {
"type": "string",
"description": "The supplier id. If included in the POST request it will cause an update instead of a creating a new object."
},
"name": {
"type": "string",
"description": "The supplier company name"
},
"note": {
"type": "string",
"description": "The note value"
},
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"postal_code": {
"type": "string",
"description": "The supplier’s postal code, also known as zip, postcode, Eircode, etc."
},
"region": {
"type": "string",
"description": "The supplier’s region name. Typically a province, a state, or a prefecture."
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
},
"website": {
"type": "string",
"description": "The supplier website page"
}
},
"required": [
"PCID",
"name"
]
}
loyverse_create_taxes
Create or update a single tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z) |
deleted_at | string | No | — | The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z) |
id | string | No | — | The tax id. If included in the POST request it will cause an update instead of a creating a new object. |
name | string | Yes | — | The tax name |
rate | number | Yes | — | The tax rate. For example, a value of “5.255” corresponds to a percentage of 5.255% |
stores | string[] | No | — | The list of store ids where this tax is available |
type | string | Yes | — | If the type is INCLUDED then the tax is included in an item price. If the type is ADDED then the tax is added to an item price |
updated_at | string | No | — | The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "The time when this resource was created (ISO 8601 format, e.g. 2020-03-25T19:55:23.077Z)"
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was deleted (ISO 8601 format, e.g. 2020-04-02T23:45:20.050Z)"
},
"id": {
"type": "string",
"description": "The tax id. If included in the POST request it will cause an update instead of a creating a new object."
},
"name": {
"type": "string",
"description": "The tax name"
},
"rate": {
"type": "number",
"description": "The tax rate. For example, a value of \"5.255\" corresponds to a percentage of 5.255%"
},
"stores": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of store ids where this tax is available"
},
"type": {
"type": "string",
"description": "If the type is `INCLUDED` then the tax is included in an item price. If the type is `ADDED` then the tax is added to an item price",
"enum": [
"INCLUDED",
"ADDED"
]
},
"updated_at": {
"type": "string",
"description": "The time when this resource was updated (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
}
},
"required": [
"PCID",
"name",
"rate",
"type"
]
}
loyverse_create_variants
Create or update a single variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
barcode | string | No | — | The barcode value |
cost | number | No | — | The variant cost |
created_at | string | No | — | The time when this resource was created |
default_price | number | No | — | The default variant price (only for pricing_type: FIXED) If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the stores array for a particular store. |
default_pricing_type | string | No | — | The default variant pricing type. If the value is VARIABLE than the price is specified at the time of a sale. If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the stores array for a particular store. |
deleted_at | string | No | — | The time when this resource was created |
item_id | string | Yes | — | The item id this variant is attached to. |
option1_value | string | No | — | The value of the first option for this variant. Required if option1_name is set for the item this variant is attached to. |
option2_value | string | No | — | The value of the second option for this variant. Required if option2_name is set for the item this variant is attached to. |
option3_value | string | No | — | The value of the third option for this variant. Required if option3_name is set for the item this variant is attached to. |
purchase_cost | number | No | — | The variant purchase cost |
reference_variant_id | string | No | — | External reference id for the variant |
sku | string | No | — | The variant sku. It should be unique. |
stores | object[] | No | — | The list of values that are unique for each store |
updated_at | string | No | — | The time when this resource was created |
variant_id | string | No | — | The read only internal id of the variant. If included in the POST request it will cause an update instead of a creating a new object. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"barcode": {
"type": "string",
"description": "The barcode value"
},
"cost": {
"type": "number",
"description": "The variant cost"
},
"created_at": {
"type": "string",
"description": "The time when this resource was created"
},
"default_price": {
"type": "number",
"description": "The default variant price (only for `pricing_type: FIXED`) If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the `stores` array for a particular store."
},
"default_pricing_type": {
"type": "string",
"description": "The default variant pricing type. If the value is `VARIABLE` than the price is specified at the time of a sale. If there are several stores in the account than the price of the variant in each store is equal to this value by default unless different value is specified in the `stores` array for a particular store.",
"enum": [
"FIXED",
"VARIABLE"
]
},
"deleted_at": {
"type": "string",
"description": "The time when this resource was created"
},
"item_id": {
"type": "string",
"description": "The item id this variant is attached to."
},
"option1_value": {
"type": "string",
"description": "The value of the first option for this variant. Required if option1_name is set for the item this variant is attached to."
},
"option2_value": {
"type": "string",
"description": "The value of the second option for this variant. Required if option2_name is set for the item this variant is attached to."
},
"option3_value": {
"type": "string",
"description": "The value of the third option for this variant. Required if option3_name is set for the item this variant is attached to."
},
"purchase_cost": {
"type": "number",
"description": "The variant purchase cost"
},
"reference_variant_id": {
"type": "string",
"description": "External reference id for the variant"
},
"sku": {
"type": "string",
"description": "The variant sku. It should be unique."
},
"stores": {
"type": "array",
"items": {
"type": "object",
"properties": {
"store_id": {
"type": "string",
"description": "Store Id"
},
"pricing_type": {
"type": "string",
"enum": [
"FIXED",
"VARIABLE"
],
"description": "The variant pricing type. If the value is `VARIABLE` than the price is specified at the time of a sale. The value is equal to `default_pricing_type` by default"
},
"price": {
"type": "number",
"description": "The variant price in this store (only if pricing_type in this store is `FIXED`). The value is equal to `default_price` by default"
},
"available_for_sale": {
"type": "boolean",
"description": "If true, variant is available for sale at this store"
},
"optimal_stock": {
"type": "number",
"description": "The variant optimal stock. This value is used to automatically calculate stock while creating purchase order. [Learn more](https://help.loyverse.com/help/autofill-items-purchase-order)"
},
"low_stock": {
"type": "number",
"description": "The low stock threshold for the variant. If the variant stock is equal or below this threshold, the system shows alert in the back-office and sends email (if enabled). [Learn more](https://help.loyverse.com/help/low-stocks)"
}
}
},
"description": "The list of values that are unique for each store"
},
"updated_at": {
"type": "string",
"description": "The time when this resource was created"
},
"variant_id": {
"type": "string",
"description": "The read only internal id of the variant. If included in the POST request it will cause an update instead of a creating a new object."
}
},
"required": [
"PCID",
"item_id"
]
}
loyverse_create_webhooks
Create or update a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
created_at | string | No | — | The time when of the webhook was created |
id | string | No | — | The webhook id. Including this id in POST request will cause an update of existing webhook |
merchant_id | string | No | — | The id of the merchant which the webhook request originates from |
status | string | No | — | The current status of webhook |
type | string | Yes | — | The type value |
updated_at | string | No | — | The time when of the webhook was updated |
url | string | Yes | — | URI where the webhook should send the POST request when the event occurs |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_at": {
"type": "string",
"description": "The time when of the webhook was created"
},
"id": {
"type": "string",
"description": "The webhook id. Including this id in POST request will cause an update of existing webhook"
},
"merchant_id": {
"type": "string",
"description": "The id of the merchant which the webhook request originates from"
},
"status": {
"type": "string",
"description": "The current status of webhook",
"enum": [
"ENABLED",
"DISABLED"
]
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"inventory_levels.update",
"items.update",
"customers.update",
"receipts.update",
"shifts.create"
]
},
"updated_at": {
"type": "string",
"description": "The time when of the webhook was updated"
},
"url": {
"type": "string",
"description": "URI where the webhook should send the POST request when the event occurs"
}
},
"required": [
"PCID",
"type",
"url"
]
}
loyverse_delete_categories_by_category_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | string | Yes | — | Category Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category_id": {
"type": "string",
"description": "Category Id"
}
},
"required": [
"PCID",
"category_id"
]
}
loyverse_delete_customers_by_customer_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | Customer Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "Customer Id"
}
},
"required": [
"PCID",
"customer_id"
]
}
loyverse_delete_discounts_by_discount_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_id | string | Yes | — | Discount Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"discount_id": {
"type": "string",
"description": "Discount Id"
}
},
"required": [
"PCID",
"discount_id"
]
}
loyverse_delete_items_by_item_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"item_id": {
"type": "string",
"description": "Item Id"
}
},
"required": [
"PCID",
"item_id"
]
}
loyverse_delete_items_by_item_id_image
Delete a single image Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"item_id": {
"type": "string",
"description": "Item Id"
}
},
"required": [
"PCID",
"item_id"
]
}
loyverse_delete_modifiers_by_modifier_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_id | string | Yes | — | Modifier Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modifier_id": {
"type": "string",
"description": "Modifier Id"
}
},
"required": [
"PCID",
"modifier_id"
]
}
loyverse_delete_pos_devices_by_pos_device_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pos_device_id | string | Yes | — | Pos Device Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pos_device_id": {
"type": "string",
"description": "Pos Device Id"
}
},
"required": [
"PCID",
"pos_device_id"
]
}
loyverse_delete_suppliers_by_supplier_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
supplier_id | string | Yes | — | Supplier Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"supplier_id": {
"type": "string",
"description": "Supplier Id"
}
},
"required": [
"PCID",
"supplier_id"
]
}
loyverse_delete_taxes_by_tax_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_id | string | Yes | — | Tax Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tax_id": {
"type": "string",
"description": "Tax Id"
}
},
"required": [
"PCID",
"tax_id"
]
}
loyverse_delete_variants_by_variant_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variant_id | string | Yes | — | Variant Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"variant_id": {
"type": "string",
"description": "Variant Id"
}
},
"required": [
"PCID",
"variant_id"
]
}
loyverse_delete_webhooks_by_webhook_id
Delete a single resource Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "Webhook Id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
loyverse_get_categories_by_category_id
Get a single category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | string | Yes | — | Category Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category_id": {
"type": "string",
"description": "Category Id"
}
},
"required": [
"PCID",
"category_id"
]
}
loyverse_get_customers_by_customer_id
Get a single customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_id | string | Yes | — | Customer Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "string",
"description": "Customer Id"
}
},
"required": [
"PCID",
"customer_id"
]
}
loyverse_get_discounts_by_discount_id
Get a single discount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_id | string | Yes | — | Discount Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"discount_id": {
"type": "string",
"description": "Discount Id"
}
},
"required": [
"PCID",
"discount_id"
]
}
loyverse_get_employees_by_employee_id
Get a single employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employee_id | string | Yes | — | Employee Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"employee_id": {
"type": "string",
"description": "Employee Id"
}
},
"required": [
"PCID",
"employee_id"
]
}
loyverse_get_items_by_item_id
Get a single item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"item_id": {
"type": "string",
"description": "Item Id"
}
},
"required": [
"PCID",
"item_id"
]
}
loyverse_get_merchant
Get merchant informationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
loyverse_get_modifiers_by_modifier_id
Get a single modifier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_id | string | Yes | — | Modifier Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modifier_id": {
"type": "string",
"description": "Modifier Id"
}
},
"required": [
"PCID",
"modifier_id"
]
}
loyverse_get_payment_types_by_payment_type_id
Get a single payment type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_type_id | string | Yes | — | Payment Type Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"payment_type_id": {
"type": "string",
"description": "Payment Type Id"
}
},
"required": [
"PCID",
"payment_type_id"
]
}
loyverse_get_pos_devices_by_pos_device_id
Get a single pos device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pos_device_id | string | Yes | — | Pos Device Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pos_device_id": {
"type": "string",
"description": "Pos Device Id"
}
},
"required": [
"PCID",
"pos_device_id"
]
}
loyverse_get_receipts_by_receipt_number
Get a single receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_number | string | Yes | — | The unique number of the receipt |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_number": {
"type": "string",
"description": "The unique number of the receipt"
}
},
"required": [
"PCID",
"receipt_number"
]
}
loyverse_get_shifts_by_shift_id
Get a single shift Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shift_id | string | Yes | — | Shift Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"shift_id": {
"type": "string",
"description": "Shift Id"
}
},
"required": [
"PCID",
"shift_id"
]
}
loyverse_get_stores_by_store_id
Get a single store Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | Yes | — | Store Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"store_id": {
"type": "string",
"description": "Store Id"
}
},
"required": [
"PCID",
"store_id"
]
}
loyverse_get_suppliers_by_supplier_id
Get a single supplier Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
supplier_id | string | Yes | — | Supplier Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"supplier_id": {
"type": "string",
"description": "Supplier Id"
}
},
"required": [
"PCID",
"supplier_id"
]
}
loyverse_get_taxes_by_tax_id
Get a single tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_id | string | Yes | — | Tax Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tax_id": {
"type": "string",
"description": "Tax Id"
}
},
"required": [
"PCID",
"tax_id"
]
}
loyverse_get_variants_by_variant_id
Get a single item variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variant_id | string | Yes | — | Variant Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"variant_id": {
"type": "string",
"description": "Variant Id"
}
},
"required": [
"PCID",
"variant_id"
]
}
loyverse_get_webhooks_by_webhook_id
Get a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "Webhook Id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
loyverse_list_categories
Get a list of categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categories_ids | string | No | — | Return only categories specified by a comma-separated list of IDs |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categories_ids": {
"type": "string",
"description": "Return only categories specified by a comma-separated list of IDs"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
}
},
"required": [
"PCID"
]
}
loyverse_list_customers
Get a list of customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customer_ids | string | No | — | Return only customers specified by a comma-separated list of IDs |
email | string | No | — | Filter customers by email |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_ids": {
"type": "string",
"description": "Return only customers specified by a comma-separated list of IDs"
},
"email": {
"type": "string",
"description": "Filter customers by email"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_discounts
Get a list of discounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
discount_ids | string | No | — | Return only discounts specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"discount_ids": {
"type": "string",
"description": "Return only discounts specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_employees
Get a list of employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employee_ids | string | No | — | Return only employees specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"employee_ids": {
"type": "string",
"description": "Return only employees specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_inventory
Inventory levels for item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | Show inventory levels only for specified stores |
variant_ids | string | No | — | Show inventory levels only for specified variants |
updated_at_min | string | No | — | Show inventory levels updated at or after specified date |
updated_at_max | string | No | — | Show inventory levels updated at or before specified date |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"store_ids": {
"type": "string",
"description": "Show inventory levels only for specified stores"
},
"variant_ids": {
"type": "string",
"description": "Show inventory levels only for specified variants"
},
"updated_at_min": {
"type": "string",
"description": "Show inventory levels updated at or after specified date"
},
"updated_at_max": {
"type": "string",
"description": "Show inventory levels updated at or before specified date"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_items
Get a list of items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
items_ids | string | No | — | Return only items specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"items_ids": {
"type": "string",
"description": "Return only items specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
}
},
"required": [
"PCID"
]
}
loyverse_list_modifiers
Get a list of modifiers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modifier_ids | string | No | — | Return only modifiers specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modifier_ids": {
"type": "string",
"description": "Return only modifiers specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_payment_types
Get a list of payment types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
payment_type_ids | string | No | — | Return only payment types specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"payment_type_ids": {
"type": "string",
"description": "Return only payment types specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_pos_devices
Get a list of pos devices Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_id | string | No | — | Show pos devices only for specified store |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"store_id": {
"type": "string",
"description": "Show pos devices only for specified store"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_receipts
Get a list of receipts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_numbers | string | No | — | Return only receipts specified by a comma-separated list of receipt numbers |
since_receipt_number | string | No | — | Show receipts since date which is equal to created_at date of the receipt with specified number |
before_receipt_number | string | No | — | Show receipts up to date which is equal to created_at date of the receipt with specified number |
store_id | string | No | — | Show receipts only for specified store |
order | string | No | — | Filter receipts by order |
source | string | No | — | The name of the the source this receipt comes from |
updated_at_min | string | No | — | Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"receipt_numbers": {
"type": "string",
"description": "Return only receipts specified by a comma-separated list of receipt numbers"
},
"since_receipt_number": {
"type": "string",
"description": "Show receipts since date which is equal to created_at date of the receipt with specified number"
},
"before_receipt_number": {
"type": "string",
"description": "Show receipts up to date which is equal to created_at date of the receipt with specified number"
},
"store_id": {
"type": "string",
"description": "Show receipts only for specified store"
},
"order": {
"type": "string",
"description": "Filter receipts by order"
},
"source": {
"type": "string",
"description": "The name of the the source this receipt comes from"
},
"updated_at_min": {
"type": "string",
"description": "Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show receipts updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_shifts
Get a list of shifts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | A comma-separated list of store ids to filter shifts |
created_at_min | string | No | — | Show shifts opened after date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
created_at_max | string | No | — | Show shifts opened before date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"store_ids": {
"type": "string",
"description": "A comma-separated list of store ids to filter shifts"
},
"created_at_min": {
"type": "string",
"description": "Show shifts opened after date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
},
"created_at_max": {
"type": "string",
"description": "Show shifts opened before date (ISO 8601 format, e.g. 2020-03-30T08:05:10.020Z)"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_stores
Get a list of stores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
store_ids | string | No | — | Return only store specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"store_ids": {
"type": "string",
"description": "Return only store specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_suppliers
Get a list of suppliers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
suppliers_ids | string | No | — | Return only suppliers specified by a comma-separated list of IDs |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"suppliers_ids": {
"type": "string",
"description": "Return only suppliers specified by a comma-separated list of IDs"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
}
},
"required": [
"PCID"
]
}
loyverse_list_taxes
Get a list of taxes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tax_ids | string | No | — | Return only taxes specified by a comma-separated list of IDs |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tax_ids": {
"type": "string",
"description": "Return only taxes specified by a comma-separated list of IDs"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_list_variants
Get a list of item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
variants_ids | string | No | — | Return only variants specified by a comma-separated list of IDs |
items_ids | string | No | — | Return only variants attached to specified item ids |
sku | string | No | — | Filter variants by sku |
created_at_min | string | No | — | Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
created_at_max | string | No | — | Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_min | string | No | — | Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
updated_at_max | string | No | — | Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z) |
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
show_deleted | boolean | No | — | Show deleted modifiers and modifier options |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"variants_ids": {
"type": "string",
"description": "Return only variants specified by a comma-separated list of IDs"
},
"items_ids": {
"type": "string",
"description": "Return only variants attached to specified item ids"
},
"sku": {
"type": "string",
"description": "Filter variants by sku"
},
"created_at_min": {
"type": "string",
"description": "Show resources created after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"created_at_max": {
"type": "string",
"description": "Show resources created before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_min": {
"type": "string",
"description": "Show resources updated after date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"updated_at_max": {
"type": "string",
"description": "Show resources updated before date (ISO 8601 format, e.g: 2020-03-30T18:30:00.000Z)"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
},
"show_deleted": {
"type": "boolean",
"description": "Show deleted modifiers and modifier options"
}
},
"required": [
"PCID"
]
}
loyverse_list_webhooks
Get a list of webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Used for pagination |
cursor | string | No | — | Used for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Used for pagination"
},
"cursor": {
"type": "string",
"description": "Used for pagination"
}
},
"required": [
"PCID"
]
}
loyverse_update_inventory
Batch update inventory levels for item variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventory_levels | object[] | Yes | — | Inventory Levels |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inventory_levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "string",
"description": "The variant id for inventory level update"
},
"store_id": {
"type": "string",
"description": "The store id for inventory level update"
},
"stock_after": {
"type": "number",
"description": "New stock value of the item variant"
}
},
"required": [
"variant_id",
"store_id",
"stock_after"
]
},
"description": "Inventory Levels"
}
},
"required": [
"PCID",
"inventory_levels"
]
}
loyverse_upload_items_by_item_id_image
Upload a single image Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
item_id | string | Yes | — | Item Id |
body | string | No | — | Request body |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"item_id": {
"type": "string",
"description": "Item Id"
},
"body": {
"type": "string",
"description": "Request body"
}
},
"required": [
"PCID",
"item_id"
]
}

