Ecommerce

Suggest Edits

ecommerce-customer

Schema:

{
  "addresses": {
    "items": {
      "properties": {
        "address_type": {
          "enum": [
            "PRIMARY",
            "SECONDARY",
            "OFFICE",
            "SHIPPING",
            "BILLING",
            "OTHER"
          ],
          "title": "Address Type",
          "type": "string"
        },
        "city": {
          "title": "City",
          "type": "string"
        },
        "country": {
          "title": "Country",
          "type": "string"
        },
        "postal_code": {
          "title": "Postal Code",
          "type": "string"
        },
        "state": {
          "title": "State",
          "type": "string"
        },
        "street_1": {
          "title": "Street 1",
          "type": "string"
        },
        "street_2": {
          "title": "Street 2",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Addresses",
    "type": "array"
  },
  "email_addresses": {
    "items": {
      "properties": {
        "email_address": {
          "format": "email",
          "title": "Email Address",
          "type": "string"
        },
        "email_type": {
          "enum": [
            "WORK",
            "PERSONAL",
            "OTHER"
          ],
          "title": "Email Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Email Addresses",
    "type": "array"
  },
  "first_name": {
    "title": "First Name",
    "type": "string"
  },
  "is_active": {
    "title": "Active",
    "type": "boolean"
  },
  "last_name": {
    "title": "Last Name",
    "type": "string"
  },
  "last_purchase": {
    "format": "date-time",
    "title": "Last Purchase",
    "type": "string"
  },
  "money_spent": {
    "title": "Money Spent",
    "type": "number"
  },
  "phone_numbers": {
    "items": {
      "properties": {
        "phone_number": {
          "title": "Phone Number",
          "type": "string"
        },
        "phone_type": {
          "enum": [
            "HOME",
            "WORK",
            "PERSONAL",
            "MOBILE",
            "OTHER"
          ],
          "title": "Phone Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Phone Numbers",
    "type": "array"
  }
}

Example Object:

{
  "addresses": [
    {
      "address_type": "PRIMARY",
      "city": "New York",
      "country": "USA",
      "postal_code": "10001",
      "state": "NY",
      "street_1": "123 Main St",
      "street_2": "Apt 101"
    },
    {
      "address_type": "SHIPPING",
      "city": "Los Angeles",
      "country": "USA",
      "postal_code": "90001",
      "state": "CA",
      "street_1": "456 Elm St",
      "street_2": "Apt 101"
    }
  ],
  "email_addresses": [
    {
      "email_address": "[email protected]",
      "email_type": "WORK"
    },
    {
      "email_address": "[email protected]",
      "email_type": "PERSONAL"
    }
  ],
  "first_name": "John",
  "is_active": true,
  "last_name": "Doe",
  "last_purchase": "2023-12-15 10:30:00",
  "money_spent": 500.25,
  "phone_numbers": [
    {
      "phone_number": "123-456-7890",
      "phone_type": "HOME"
    },
    {
      "phone_number": "987-654-3210",
      "phone_type": "MOBILE"
    }
  ]
}

ecommerce-order

Schema:

{
  "addresses": {
    "items": {
      "properties": {
        "address_type": {
          "enum": [
            "PRIMARY",
            "SECONDARY",
            "OFFICE",
            "SHIPPING",
            "BILLING",
            "OTHER"
          ],
          "title": "Address Type",
          "type": "string"
        },
        "city": {
          "title": "City",
          "type": "string"
        },
        "country": {
          "title": "Country",
          "type": "string"
        },
        "postal_code": {
          "title": "Postal Code",
          "type": "string"
        },
        "state": {
          "title": "State",
          "type": "string"
        },
        "street_1": {
          "title": "Street 1",
          "type": "string"
        },
        "street_2": {
          "title": "Street 2",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Addresses",
    "type": "array"
  },
  "currency": {
    "title": "Currency",
    "type": "string"
  },
  "customer_ip": {
    "title": "Customer IP Address",
    "type": "string"
  },
  "date_completed": {
    "format": "date-time",
    "title": "Date Completed",
    "type": "string"
  },
  "date_created": {
    "format": "date-time",
    "title": "Date Created",
    "type": "string"
  },
  "date_modified": {
    "format": "date-time",
    "title": "Date Modified",
    "type": "string"
  },
  "date_paid": {
    "format": "date-time",
    "title": "Date Paid",
    "type": "string"
  },
  "discount_tax": {
    "title": "Discount Tax",
    "type": "number"
  },
  "discount_total": {
    "title": "Discount Total",
    "type": "number"
  },
  "email_addresses": {
    "items": {
      "properties": {
        "email_address": {
          "format": "email",
          "title": "Email Address",
          "type": "string"
        },
        "email_type": {
          "enum": [
            "WORK",
            "PERSONAL",
            "OTHER"
          ],
          "title": "Email Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Email Addresses",
    "type": "array"
  },
  "first_name": {
    "title": "First Name",
    "type": "string"
  },
  "last_name": {
    "title": "Last Name",
    "type": "string"
  },
  "line_items": {
    "items": {
      "properties": {
        "price": {
          "title": "Price",
          "type": "number"
        },
        "product_name": {
          "title": "Product",
          "type": "string"
        },
        "quantity": {
          "title": "Quantity",
          "type": "number"
        },
        "subtotal": {
          "title": "Subtotal",
          "type": "number"
        },
        "subtotal_tax": {
          "title": "Subtotal Tax",
          "type": "number"
        },
        "total": {
          "title": "Total",
          "type": "number"
        },
        "total_tax": {
          "title": "Total Tax",
          "type": "number"
        }
      },
      "type": "object"
    },
    "title": "Items",
    "type": "array"
  },
  "order_number": {
    "title": "Order Number",
    "type": "number"
  },
  "payment_method": {
    "title": "Payment Method",
    "type": "string"
  },
  "phone_numbers": {
    "items": {
      "properties": {
        "phone_number": {
          "title": "Phone Number",
          "type": "string"
        },
        "phone_type": {
          "enum": [
            "HOME",
            "WORK",
            "PERSONAL",
            "MOBILE",
            "OTHER"
          ],
          "title": "Phone Type",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Phone Numbers",
    "type": "array"
  },
  "set_paid": {
    "title": "Paid",
    "type": "boolean"
  },
  "shipping_tax": {
    "title": "Shipping Tax",
    "type": "number"
  },
  "shipping_total": {
    "title": "Shipping Total",
    "type": "number"
  },
  "total": {
    "title": "Total",
    "type": "number"
  },
  "total_tax": {
    "title": "Total Tax",
    "type": "number"
  }
}

Example Object:

{
  "addresses": [
    {
      "address_type": "PRIMARY",
      "city": "New York",
      "country": "United States",
      "postal_code": "10075",
      "state": "NY",
      "street_1": "20 W 34th St",
      "street_2": "Apt 101"
    }
  ],
  "currency": "USD",
  "customer_ip": "111.111.11.111",
  "date_completed": "2024-01-02 00:00:00",
  "date_created": "2024-01-01 00:00:00",
  "date_modified": "2024-01-02 00:00:00",
  "date_paid": "2024-01-02 00:00:00",
  "discount_tax": 1000,
  "discount_total": 1000,
  "email_addresses": [
    {
      "email_address": "[email protected]",
      "email_type": "WORK"
    }
  ],
  "first_name": "John",
  "last_name": "Doe",
  "line_items": [
    {
      "price": 1000,
      "product_name": "Integration",
      "quantity": 50,
      "subtotal": 1000,
      "subtotal_tax": 1000,
      "total": 1000,
      "total_tax": 1000
    }
  ],
  "order_number": 1000,
  "payment_method": "Credit Card",
  "phone_numbers": [
    {
      "phone_number": "+1 631-555-1234",
      "phone_type": "WORK"
    }
  ],
  "set_paid": true,
  "shipping_tax": 1000,
  "shipping_total": 1000,
  "total": 1000,
  "total_tax": 1000
}

ecommerce-product

{
  "brand_name": {
    "title": "Brand Name",
    "type": "string"
  },
  "date_created": {
    "format": "date-time",
    "title": "Date Created",
    "type": "string"
  },
  "date_updated": {
    "format": "date-time",
    "title": "Date Updated",
    "type": "string"
  },
  "description": {
    "title": "Description",
    "type": "string"
  },
  "featured": {
    "title": "Featured",
    "type": "boolean"
  },
  "images": {
    "items": {
      "properties": {
        "uri": {
          "format": "uri",
          "title": "URL",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "inventory_quantity": {
    "title": "Inventory Quantity",
    "type": "number"
  },
  "is_free_shipping": {
    "title": "Free Shipping",
    "type": "boolean"
  },
  "on_sale": {
    "title": "On Sale",
    "type": "boolean"
  },
  "options": {
    "items": {
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        },
        "values": {
          "items": {
            "type": "string"
          },
          "title": "Values",
          "type": "array"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "price": {
    "title": "Price",
    "type": "number"
  },
  "product_name": {
    "title": "Product Name",
    "type": "string"
  },
  "purchase_note": {
    "title": "Purchase Note",
    "type": "string"
  },
  "sku": {
    "title": "SKU",
    "type": "string"
  },
  "status": {
    "enum": [
      "ACTIVE",
      "ARCHIVED"
    ],
    "title": "Status",
    "type": "string"
  },
  "total_sold": {
    "title": "Total Sold",
    "type": "number"
  },
  "variants": {
    "items": {
      "properties": {
        "inventory_quantity": {
          "title": "Inventory Quantity",
          "type": "number"
        },
        "name": {
          "title": "Name",
          "type": "string"
        },
        "price": {
          "title": "Price",
          "type": "number"
        },
        "sku": {
          "title": "SKU",
          "type": "string"
        },
        "weight": {
          "title": "Weight",
          "type": "number"
        },
        "weight_unit": {
          "title": "Weight Unit",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "warranty": {
    "title": "Warranty",
    "type": "string"
  },
  "weight": {
    "title": "Weight",
    "type": "number"
  },
  "weight_unit": {
    "title": "Weight Unit",
    "type": "string"
  }
}

Example Object:

{
  "brand_name": "Example Brand",
  "date_created": "2024-02-28 12:00:00",
  "date_updated": "2024-02-28 12:00:00",
  "description": "This is an example product description.",
  "featured": true,
  "images": [
    {
      "uri": "https://example.com/image1.jpg"
    },
    {
      "uri": "https://example.com/image2.jpg"
    }
  ],
  "inventory_quantity": 100,
  "is_free_shipping": true,
  "on_sale": false,
  "options": [
    {
      "name": "Color",
      "values": ["Red", "Blue", "Green"]
    },
    {
      "name": "Size",
      "values": ["Small", "Medium", "Large"]
    }
  ],
  "price": 50.99,
  "product_name": "Example Product",
  "purchase_note": "Please note that this is just an example product.",
  "sku": "EX123456",
  "status": "ACTIVE",
  "total_sold": 50,
  "variants": [
    {
      "inventory_quantity": 50,
      "name": "Variant 1",
      "price": 49.99,
      "sku": "EX123456-V1",
      "weight": 0.5,
      "weight_unit": "kg"
    },
    {
      "inventory_quantity": 25,
      "name": "Variant 2",
      "price": 59.99,
      "sku": "EX123456-V2",
      "weight": 0.7,
      "weight_unit": "kg"
    }
  ],
  "warranty": "1 year warranty provided.",
  "weight": 0.6,
  "weight_unit": "kg"
}

ecommerce-product_category

Schema:

{
  "count": {
    "title": "Count",
    "type": "number"
  },
  "default_product_sort": {
    "title": "Default Product Sort",
    "type": "string"
  },
  "description": {
    "title": "Description",
    "type": "string"
  },
  "display": {
    "title": "Display",
    "type": "string"
  },
  "images": {
    "items": {
      "properties": {
        "uri": {
          "format": "uri",
          "title": "URL",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "is_visible": {
    "title": "Visible",
    "type": "boolean"
  },
  "name": {
    "title": "Name",
    "type": "string"
  },
  "parent": {
    "title": "Parent",
    "type": "number"
  },
  "search_keywords": {
    "items": {
      "type": "string"
    },
    "type": "array"
  },
  "sort_order": {
    "title": "Sort Order",
    "type": "number"
  },
  "views": {
    "title": "Views",
    "type": "number"
  }
}

Example Object:

{
  "count": 10,
  "default_product_sort": "price_asc",
  "description": "This is a sample product description.",
  "display": "grid",
  "images": [
    {
      "uri": "https://example.com/image1.jpg"
    },
    {
      "uri": "https://example.com/image2.jpg"
    },
    {
      "uri": "https://example.com/image3.jpg"
    }
  ],
  "is_visible": true,
  "name": "Sample Product",
  "parent": 123,
  "search_keywords": ["sample", "product", "example"],
  "sort_order": 1,
  "views": 100
}

ecommerce-product_collection

Schema:

{
  "description": {
    "title": "Description",
    "type": "string"
  },
  "handle": {
    "title": "Handle",
    "type": "string"
  },
  "images": {
    "items": {
      "properties": {
        "uri": {
          "format": "uri",
          "title": "URL",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "products_count": {
    "title": "Products Count",
    "type": "number"
  },
  "published_at": {
    "format": "date-time",
    "title": "Published At",
    "type": "string"
  },
  "title": {
    "title": "Title",
    "type": "string"
  },
  "updated_at": {
    "format": "date-time",
    "title": "Updated At",
    "type": "string"
  }
}

Example Object:

{
  "description": "Test Description",
  "handle": "Test Handle",
  "images": [
    {
      "uri": "https://endgrate.com"
    }
  ],
  "products_count": 1000,
  "published_at": "2024-01-01 00:00:00",
  "title": "Test Title",
  "updated_at": "2024-01-02 00:00:00"
}

ecommerce-product_variant

{
  "brand_name": {
    "title": "Brand Name",
    "type": "string"
  },
  "date_created": {
    "format": "date-time",
    "title": "Date Created",
    "type": "string"
  },
  "date_updated": {
    "format": "date-time",
    "title": "Date Updated",
    "type": "string"
  },
  "description": {
    "title": "Description",
    "type": "string"
  },
  "featured": {
    "title": "Featured",
    "type": "boolean"
  },
  "images": {
    "items": {
      "properties": {
        "uri": {
          "format": "uri",
          "title": "URL",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "inventory_quantity": {
    "title": "Inventory Quantity",
    "type": "number"
  },
  "is_free_shipping": {
    "title": "Free Shipping",
    "type": "boolean"
  },
  "on_sale": {
    "title": "On Sale",
    "type": "boolean"
  },
  "options": {
    "items": {
      "properties": {
        "name": {
          "title": "Name",
          "type": "string"
        },
        "values": {
          "items": {
            "type": "string"
          },
          "title": "Values",
          "type": "array"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "price": {
    "title": "Price",
    "type": "number"
  },
  "product_name": {
    "title": "Product Name",
    "type": "string"
  },
  "purchase_note": {
    "title": "Purchase Note",
    "type": "string"
  },
  "sku": {
    "title": "SKU",
    "type": "string"
  },
  "status": {
    "enum": [
      "ACTIVE",
      "ARCHIVED"
    ],
    "title": "Status",
    "type": "string"
  },
  "total_sold": {
    "title": "Total Sold",
    "type": "number"
  },
  "warranty": {
    "title": "Warranty",
    "type": "string"
  },
  "weight": {
    "title": "Weight",
    "type": "number"
  },
  "weight_unit": {
    "title": "Weight Unit",
    "type": "string"
  }
}

Example Object:

{
  "brand_name": "Nike",
  "date_created": "2024-02-28 15:30:00",
  "date_updated": "2024-02-28 15:35:00",
  "description": "A comfortable and stylish pair of running shoes.",
  "featured": true,
  "images": [
    {
      "uri": "https://example.com/image1.jpg"
    },
    {
      "uri": "https://example.com/image2.jpg"
    }
  ],
  "inventory_quantity": 100,
  "is_free_shipping": true,
  "on_sale": false,
  "options": [
    {
      "name": "Size",
      "values": ["7", "8", "9", "10"]
    },
    {
      "name": "Color",
      "values": ["Red", "Blue", "Green"]
    }
  ],
  "price": 99.99,
  "product_name": "Running Shoes",
  "purchase_note": "Limited stock available.",
  "sku": "NS123456",
  "status": "ACTIVE",
  "total_sold": 50,
  "warranty": "1-year manufacturer warranty",
  "weight": 0.5,
  "weight_unit": "kg"
}

Updated 3 months ago