Ecommerce
Integration Provider | Customer | Order | Product | Other |
---|---|---|---|---|
BigCommerce | ✅ | ✅ | ✅ | Product Category |
Shopify | ✅ | ✅ | ✅ | Product Collection |
Stamped | ✅ | ✅ | ||
WooCommerce | ✅ | ✅ | ✅ | Product Category |
Don't see the integration provider or resource you want? Let us know and we will build it out ASAP!
Customer: ecommerce-customer
ecommerce-customer
A customer is an individual who buys goods or services from the business.
{
"shipping_address": {
"title": "Shipping Address",
"type": "object",
"description": "The shipping address of the customer",
"properties": {
"shipping_city": {
"title": "Shipping City",
"type": "string",
"description": "The city of the shipping address."
},
"shipping_country": {
"title": "Shipping Country",
"type": "string",
"description": "The country of the shipping address."
},
"shipping_postal_code": {
"title": "Shipping Postal Code",
"type": "string",
"description": "The postal or ZIP code of the shipping address."
},
"shipping_state": {
"title": "Shipping State",
"type": "string",
"description": "The state or region of the shipping address."
},
"shipping_street_1": {
"title": "Shipping Street 1",
"type": "string",
"description": "Line 1 of the street for the shipping address."
},
"shipping_street_2": {
"title": "Shipping Street 2",
"type": "string",
"description": "Line 2 of the street for the shipping address."
}
}
},
"billing_address": {
"title": "Billing Address",
"type": "object",
"description": "The billing address of the customer",
"properties": {
"billing_city": {
"title": "Billing City",
"type": "string",
"description": "The city of the billing address."
},
"billing_country": {
"title": "Billing Country",
"type": "string",
"description": "The country of the billing address."
},
"billing_postal_code": {
"title": "Billing Postal Code",
"type": "string",
"description": "The postal or ZIP code of the billing address."
},
"billing_state": {
"title": "Billing State",
"type": "string",
"description": "The state or region of the billing address."
},
"billing_street_1": {
"title": "Billing Street 1",
"type": "string",
"description": "Line 1 of the street for the billing address."
},
"billing_street_2": {
"title": "Billing Street 2",
"type": "string",
"description": "Line 2 of the street for the billing address."
}
}
},
"email_address": {
"format": "email",
"title": "Email Address",
"type": "string",
"description":"Primary email address of the customer"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"title": {
"title": "Title",
"type": "string",
},
"phone_number": {
"title": "Phone Number",
"type": "string",
"description":"Primary phone number for the customer"
}
}
{
"shipping_address":
{
"shipping_city": "New York",
"shipping_country": "USA",
"shipping_postal_code": "10001",
"shipping_state": "NY",
"shipping_street_1": "123 Main St",
"shipping_street_2": "Apt 101"
},
"billing_address":{
"billing_city": "Los Angeles",
"billing_country": "USA",
"billing_postal_code": "90001",
"billing_state": "CA",
"billing_street_1": "456 Elm St",
"billing_street_2": "Apt 101"
},
"email_address": "[email protected]",
"first_name": "John",
"is_active": true,
"last_name": "Doe",
"phone_number": "123-456-7890"
}
Order: ecommerce-order
ecommerce-order
An order is a completed purchase for a product or good.
{
"customer_id": {
"title": "Customer ID",
"type": "string",
"description": "The unique identifier of the customer linked to the order.",
},
"order_number": {
"title": "Order Number",
"type": "string",
},
"transaction_date": {
"title": "Transaction Date",
"type": "string",
"format": "date-time",
"description": "The transaction logged date of the order."
},
"payment_status": {
"enum": [
"PENDING",
"AUTHORIZED",
"PAID",
"PARTIALLY_PAID",
"REFUNDED",
"VOID",
"UNKNOWN",
],
"title": "Status",
"type": "string",
"description": "The payment status of the order."
},
"fulfillment_status": {
"enum": [
"PENDING",
"SHIPPED",
"DELIVERED",
"PARTIALLY_DELIVERED",
"CANCELLED",
"RETURNED",
"UNKNOWN",
],
"title": "Status",
"type": "string",
"description": "The fulfillment status of the order."
},
"tax_amount": {
"title": "Tax Amount",
"type": "number",
"description": "The total tax amount applied to the order."
},
"discount_amount": {
"title": "Discount Amount",
"type": "number",
"description": "The total discount amount applied to the order."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The total amount due on the order."
},
"line_items": {
"title": "Line Items",
"type": "array",
"description": "The line items associated with the order.",
"items": {
"type": "object",
"properties": {
"item_name": {
"title": "Item Name",
"type": "string",
"description": "The name of the order line item."
},
"description": {
"title": "Description",
"type": "string",
"description": "The description of the order line item."
},
"quantity": {
"title": "Quantity",
"type": "number",
"description": "The quantity of the order line item."
},
"unit_price": {
"title": "Unit Price",
"type": "number",
"description": "The unit price of the order line item."
},
"tax_amount": {
"title": "Tax Amount",
"type": "number",
"description": "The tax amount of the order line item."
},
"total_amount": {
"title": "Total Amount",
"type": "number",
"description": "The total payment amount, including tax, of the order line item."
},
},
}
},
"note": {
"title": "Note",
"type": "string"
}
}
{
"customer_id": "XXXXXX",
"order_number": "1000",
"transaction_date": "2024-01-01T00:00:00Z",
"payment_status": "PAID",
"fulfillment_status": "DELIVERED",
"tax_amount": 1000,
"discount_amount": 1000,
"total_amount": 1000,
"line_items": [
{
"item_name": "Integration",
"description": "Integration service",
"quantity": 50,
"unit_price": 1000,
"tax_amount": 1000,
"total_amount": 1000
}
],
"note": "This is a sample order."
}
Product: ecommerce-product
ecommerce-product
A product is a good or service that is offered.
Note: the options
attribute in variants
must uniquely define each variant.
{
"name": {
"title": "Name",
"type": "string",
"description": "The name of the product."
},
"description": {
"title": "Description",
"type": "string",
"description": "The description of the product."
},
"type": {
"enum":[
"PHYSICAL",
"DIGITAL",
],
"title": "Type",
"type": "string",
"description": "The type of the product."
},
"is_visible":{
"title": "Is Visible",
"type": "boolean",
"description": "Indicates if the item is visible to customers."
},
"tags": {
"title": "Tags",
"description": "The tags of the product.",
"type": "array",
"items": {
"type": "string",
"description": "The tag of the product."
}
},
"categories": {
"title": "Categories",
"description": "The categories of the product.",
"type": "array",
"items": {
"type": "string",
"description": "The category of the product."
}
},
"variants": {
"title": "Variants",
"type": "array",
"description": "The variants of a product.",
"items": {
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"title": "Image: URL",
"type": "string",
"format": "uri",
"description": "The image url of the product variant."
}
},
},
},
"name": {
"title": "Name",
"type": "string",
"description": "The name of the product variant."
},
"description": {
"title": "Description",
"type": "string",
"description": "The description of the product variant."
},
"status": {
"enum": [
"ACTIVE",
"ARCHIVED",
"DRAFT"
],
"title": "Status",
"type": "string",
"description": "The status of the product variant."
},
"price": {
"title": "Variant Price",
"type": "number",
"description": "The price of the product variant."
},
"sku": {
"title": "Variant SKU",
"type": "string",
"description": "The SKU of the product variant."
},
"weight": {
"title": "Variant Weight",
"type": "number",
"description": "The weight of the product variant."
},
"weight_unit": {
"title": "Variant Weight Unit",
"type": "string",
"description": "The weight unit of the product variant."
},
"inventory_quantity": {
"title": "Variant Inventory Quantity",
"type": "number",
"description": "The quantity of the product variant in stock."
},
"options": {
"title": "Options",
"description": "The customizable attributes of a product.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Variant Option Name",
"type": "string",
"description": "The name of the option of the variant."
},
"value": {
"title": "Variant Option Value",
"type": "string",
"description": "The value of the option of the product."
}
},
}
},
"custom_fields": {
"title": "Custom Fields",
"description": "The custom fields of the product variant.",
"type": "array",
"items": {
"type": "object",
"properties": {
"namespace": {
"title": "Variant Custom Field Namespace",
"type": "string",
"description": "The namespace of the custom field of the variant."
},
"name": {
"title": "Variant Custom Field Name",
"type": "string",
"description": "The name of the custom field of the variant."
},
"namespace": {
"title": "Variant Custom Field Namespace",
"type": "string",
"description": "The namespace of the custom field of the variant."
},
"value": {
"title": "Variant Custom Field Value",
"type": "string",
"description": "The value of the custom field of the variant."
},
"type": {
"title": "Variant Custom Field Type",
"type": "string",
"description": "The type of the custom field of the variant.",
"enum": [
"STRING",
"NUMBER",
"BOOLEAN",
"DATE",
"DATE-TIME",
"URI",
"STRING_LIST",
"JSON"
]
}
}
}
}
},
},
}
}
{
"name": "Example Product",
"description": "This is an example product description.",
"type": "PHYSICAL",
"is_visible": true,
"tags": [],
"categories": [],
"variants": [
{
"name": "Variant 1",
"description": "Variant 1 description",
"status": "ACTIVE",
"price": 49.99,
"sku": "EX123456-V1",
"weight": 0.5,
"weight_unit": "kg",
"inventory_quantity": 50,
"images": "https://example.com",
"options": [
{
"name": "Color",
"value": "Blue"
}
],
"custom_fields": [
{
"name": "Variant Custom Field 1",
"value": "Field Value",
"type": "string"
}
],
},
{
"name": "Variant 2",
"description": "Variant 2 description",
"status": "ACTIVE",
"price": 59.99,
"sku": "EX123456-V2",
"weight": 0.7,
"weight_unit": "kg",
"inventory_quantity": 25,
"images": "https://example.com",
"options": [
{
"name": "Color",
"value": "Red"
}
]
}
]
}
Updated 3 months ago