Documentation

E-commerce & Retail Functions

Generate orders, invoices, coupons, and retail data

E-commerce & Retail Functions

Generate realistic e-commerce and retail data for testing commerce applications.


Orders & Transactions

generate_order_number

Generate e-commerce order numbers.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
format_typestringstandardstandard, amazon, shopify, sequential
columns:
  - name: order_id
    function: generate_order_number
    parameters:
      format_type: amazon

Output by format:

  • standard: ORD-20240315-12345678
  • amazon: 123-4567890-1234567
  • shopify: #1234
  • sequential: 12345678

generate_invoice_number

Generate invoice reference numbers.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
format_typestringstandardstandard, monthly, sequential, alpha
columns:
  - name: invoice_number
    function: generate_invoice_number

Output: INV-2024-123456


generate_purchase_order

Generate purchase order numbers.

Category: Commerce Type: Generator Data Types: string

columns:
  - name: po_number
    function: generate_purchase_order

Output: PO-2024-12345678


generate_return_authorization

Generate RMA (Return Merchandise Authorization) numbers.

Category: Commerce Type: Generator Data Types: string

columns:
  - name: rma_number
    function: generate_return_authorization

Output: RMA-20240315-ABC12345


Promotions & Discounts

generate_coupon_code

Generate promotional coupon codes.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
code_typestringrandomrandom, word_based, seasonal, percentage

Examples:

# Random code
columns:
  - name: coupon_code
    function: generate_coupon_code
# Word-based promotional code
columns:
  - name: promo_code
    function: generate_coupon_code
    parameters:
      code_type: word_based

Output by type:

  • random: ABC123XYZ
  • word_based: SAVE20
  • seasonal: SUMMER25
  • percentage: 15OFF

generate_discount_code

Generate discount code identifiers.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
discount_typestringpercentagepercentage, dollar, bogo, shipping, first_time
columns:
  - name: discount_code
    function: generate_discount_code
    parameters:
      discount_type: first_time

Output: WELCOME10, FREESHIP, BOGO


generate_promotion_id

Generate marketing promotion IDs.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
promotion_typestringgeneralgeneral, sale, clearance, bogo, flash, seasonal, loyalty, email, social, influencer
columns:
  - name: promotion_id
    function: generate_promotion_id
    parameters:
      promotion_type: flash

Output: FLASH-202403-1234


Customer Programs

generate_loyalty_number

Generate customer loyalty program numbers.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
program_typestringgenericgeneric, airline, hotel, retail, credit_card
columns:
  - name: loyalty_id
    function: generate_loyalty_number
    parameters:
      program_type: airline

Output by type:

  • generic: LP-123456789012
  • airline: AB12345678
  • hotel: H1234567890
  • retail: 1234 5678 9012 3456

generate_gift_card_number

Generate gift card numbers.

Category: Commerce Type: Generator Data Types: string

columns:
  - name: gift_card
    function: generate_gift_card_number

Output: 1234 5678 9012 3456


generate_affiliate_id

Generate affiliate partner IDs.

Category: Commerce Type: Generator Data Types: string

columns:
  - name: affiliate_id
    function: generate_affiliate_id

Output: AFF-ABC12345


Vendors & Suppliers

generate_vendor_code

Generate supplier/vendor codes.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
format_typestringstandardstandard, alphabetic, numeric, company_based
columns:
  - name: vendor_id
    function: generate_vendor_code
    parameters:
      format_type: company_based

Output: VEN-ABC123, ACME456


generate_marketplace_id

Generate marketplace seller IDs.

Category: Commerce Type: Generator Data Types: string

ParameterTypeDefaultDescription
marketplacestringgenericamazon, ebay, etsy, shopify, generic
columns:
  - name: seller_id
    function: generate_marketplace_id
    parameters:
      marketplace: amazon

Output by marketplace:

  • amazon: A1234567890ABC
  • ebay: seller123pro
  • etsy: creativecrafts42
  • shopify: shop-abc12345

Complete Order Example

tables:
  - name: orders
    columns:
      - name: order_id
        function: generate_order_number
      - name: invoice_number
        function: generate_invoice_number
      - name: customer_email
        function: generate_email
      - name: order_date
        function: generate_datetime
      - name: total_amount
        function: generate_price
        parameters:
          min_value: 10
          max_value: 500
      - name: coupon_code
        function: generate_coupon_code
      - name: status
        function: return_value
        parameters:
          value: "completed"