ePages Logo
  • Home
  • Docs
    • Beyond API
    • Now API
  • Blog
  • About
  • Jobs
  • Events
  • Getting started
    • Introduction
    • About the API
      • HTTP verbs
      • API operations
      • Request headers
      • Response headers
      • Sorting
      • Optional properties
      • Pagination
      • Hypermedia
      • Versioning
    • REST API errors
      • HTTP status codes
      • Error responses
      • Common error IDs
      • Validation errors
  • Beyond apps
    • Introduction
    • App integration levels
    • App conception
      • Scopes
      • Events
    • App creation
    • App authorization
      • How to implement an authorization flow
      • How to run a test authorization
      • How to verify requests from ePages
    • App submission
      • Submission guidelines
      • How to submit your app
  • Tutorials
    • JavaScript
    • Rails
  • Integrations
    • Payment solution
      • Getting started
      • Payment Method Definitions
      • Authorization
      • Payment Methods
      • Merchant registration
      • Payment flow
      • Create a payment
      • Approve a payment
      • Capture a payment
      • Status transitions
      • Set a payment status
      • Refunds
      Ruby client
    • Postman Collection
  • API Reference
    • Change log
    • Authentication API
      • Email address change
        • Trigger email address change
      • Tokens
        • Create a JsonWebToken from Authorization Code
        • Create a JsonWebToken from Refresh Token
        • Create a JsonWebToken from Client Credentials
      • Username & Password
        • Verify password
        • Change password
        • Trigger password reset email
        • Change username
      • Signers
        • Create signer
        • List signers
        • Delete signer
    • Checkout API
      • Carts
        • Create cart
        • Show cart details
        • Delete cart
        • Create order from cart
        • Add single line item to cart
        • Replace single line item
        • Replace line items
        • Delete line item
        • Set cart billing address
        • Set cart shipping address
        • Remove cart shipping address
        • List applicable payment methods for current cart
        • Set current cart payment method
        • Set cart payment method to current default
        • Show current cart payment method details
        • Create payment
        • Create payment and order
        • List applicable shipping methods for current cart
        • Set current cart shipping method
        • Set cart shipping method to current default
        • Show current cart shipping method details
        • Find serviceable countries
        • List applicable pickup options for current cart
        • Set current cart pickup option
        • Show current cart pickup option details
        • Remove current cart pickup option
        • Redeem coupon
        • Remove coupon from cart
      • Checkout settings
        • List checkout settings
        • Update checkout settings
      • Coupon campaigns
        • Create coupon campaign
        • List coupon campaigns
        • Show coupon campaign details
        • Update coupon campaign
        • Update coupon campaign status
        • Delete coupon campaign
        • List coupon codes
        • Update coupon codes
      • Customers
        • Assign customer to cart
        • Show latest open cart details
      • Payment methods
        • List payment methods
        • Show payment method details
        • Update payment method
        • Sort payment methods
        • Activate payment method
        • Deactivate payment method
      • Pickup options
        • Create pickup option
        • List pickup options
        • Show pickup option details
        • Update pickup option
        • Sort pickup options
        • Delete pickup option
      • Shipping zones and methods
        • Create shipping zone
        • List shipping zones
        • Show shipping zone details
        • Update shipping zone
        • Sort shipping zones
        • Delete shipping zone
        • Create shipping method in shipping zone
        • Create shipping method with weight-based price in shipping zone
        • List shipping methods of shipping zone
        • Show details of shipping method in shipping zone
        • Show details of shipping method with weight-based price in shipping zone
        • Update shipping method in shipping zone
        • Sort shipping methods in shipping zone
        • Delete shipping method in shipping zone
    • Customer API
      • Register customer
      • Create customer
      • List customers
      • Show customer details
      • Update customer
      • Delete customer
      • List customer events
    • Customer Account API
      • Show customer details in customer account
      • Show shipping address in customer account
      • Show billing address in customer account
      • List orders in customer account
      • Show order details in customer account
      • Update shipping address in customer account
      • Update billing address in customer account
      • Delete customer account
    • Order API
      • Orders
        • Create order
        • List orders
        • Show order details
        • Show order confirmation details by cart ID
        • Show order number and order ID by cart ID
        • Find used shipping countries
        • List order filter categories
        • Cancel order
        • List unviewed orders
        • Mark order as viewed
        • Mark multiple orders as viewed
        • Mark multiple orders as unviewed
        • Update order note
        • Update billing address
        • Update shipping address
      • Order batch actions
        • Introduction
        • Show order batch action status
      • Order documents
        • List order documents
        • Show order document details
        • Create invoice
        • Create multiple invoices
        • Combine multiple invoices
        • Send order document
      • Order events
        • List order events
      • Order export
        • Create order export
        • Show order export status
      • Order processes
        • General
          • List order processes
        • Cancelation processes
          • Create cancelation process
          • List cancelation processes
          • Show cancelation process details
        • Payment processes
          • List payment processes
          • Show payment process details
          • Show online payment process details
          • Show active payment process details
          • Mark payment process as voided
          • Mark payment process as paid
          • Capture payment
        • Pickup processes
          • Create pickup process
          • Create multiple pickup processes
          • List pickup processes
          • Show pickup process details
          • Mark pickup process as picked up
          • Combine multiple pickup packing slips
        • Refund processes
          • List refund processes
          • Show refund process details
          • Show active refund process details
          • Mark refund process as paid
        • Return processes
          • Create return process
          • List return processes
          • Show return process details
        • Shipping processes
          • Create shipping process
          • Create multiple shipping processes
          • List shipping processes
          • Show shipping process details
          • Mark shipment as shipped
          • Mark shipment as delivered
          • Combine multiple shipping packing slips
      • Order settings
        • List order settings
        • Update order settings
    • Payment Gateway API
      • Merchant account connection
        • Generate referral URI
        • Retrieve shop ID
        • Show merchant account details
      • Payments
        • Approve payment
        • Cancel payment
        • Fail payment
        • Set payment status
      • Payment methods
        • Create payment method
        • Retrieve payment methods
        • Delete payment method
      • Payment method definitions
        • Create payment method definition
        • List payment method definitions
        • Retrieve payment method definition
        • Update payment method definition
        • Delete payment method definition
    • Product Management API
      • Additional product descriptions
        • List additional product descriptions
        • Add additional product description
        • Update additional product description
        • Sort additional product descriptions
        • Delete additional product description
      • Products
        • Create product
        • Create variation product
        • List products including variation products
        • Show product details
        • Show variation product details
        • Update product partially
        • Update multiple products partially
        • Update variation product partially
        • Delete product
        • Delete multiple products
        • Add tags to multiple products
        • Remove tags from multiple products
      • Product attachments
        • Add product attachment
        • List product attachments
        • Show product attachment details
        • Delete product attachment
      • Product attributes
        • Create product attribute
        • List product attributes
        • Show product attribute details
        • Update product attribute
        • Delete product attribute
      • Product attribute definitions
        • Create product attribute definition
        • List product attribute definitions
        • Show product attribute definition details
        • Delete product attribute definition
      • Product availability
        • Show product availability details
        • Enable stock management
        • Disable stock management
        • Adjust stock level
        • Update reserve stock
        • Enable purchasability
        • Disable purchasability
      • Product categories
        • Create product category
        • List product categories
        • Show product category details
        • Update all product category properties
        • Update product category partially (json)
        • Delete product category
        • Add multiple products to product categories
        • Remove multiple products from product categories
      • Product category-related searches
        • Search product categories
        • Find used category tags
        • Find category manufacturers
      • Product cross-sells
        • Create product cross-sell
        • List product cross-sells
        • Show product cross-sell details
        • Update product cross-sell
        • Delete product cross-sell
      • Product images
        • Add product image
        • Add multiple product images
        • List product images
        • Show product image details
        • Upload product image
        • Upload multiple product images
        • Upload external product image
        • Sort product images
        • Delete product image
        • Assign product image as default image
      • Product-related searches
        • Search and filter products
        • Find product by SKU
        • Find used tags
        • Find manual product categories
        • Find manufacturers
        • List product search meta information
      • Product videos
        • Add product video
        • List product videos
        • Show product video details
        • Update product video
        • Delete product video
      • Variations
        • List variations
        • Show variation details
        • Update variation partially (json)
      • Variation attributes
        • List variation attributes
        • Show variation attribute details
        • Update variation attribute
        • Sort variation attributes
        • Assign variation attribute as variation images differentiator
        • Create variation attribute value
        • Sort variation attribute values
        • Delete variation attribute values of multiple variation attributes
      • Variation availability
        • Show variation availability details
        • Enable purchasability for variation
        • Disable purchasability for variation
        • Adjust stock level of variation
      • Variation images
        • Add variation image
        • Add multiple variation images
        • Add multiple variation images to multiple variations
        • List variation images
        • List variation images of all variations
        • Show variation image details
        • Upload variation image
        • Upload multiple variation images
        • Upload multiple variation images for multiple variations
        • Sort variation images
        • Sort variation images of multiple variations
        • Delete variation image
        • Delete variation images of multiple variations
        • Assign variation image as default image
      • Variation properties
        • List variation properties
        • Update variation properties
    • Product View API
      • Products
        • List products
        • List products by IDs
        • List products by tags
        • List available tags
        • List products by term
        • Show product details
        • List product cross-sells
        • List cross-selling products
      • Product attachments
        • List product attachments
        • Show product attachment details
      • Product categories
        • List product categories
        • Show product category details
        • List products of category
        • List product categories assigned to an existing product
        • Search matching product categories for product
        • Preview products included in category
      • Product images
        • List product images
        • Show product image details
      • Product media
        • List product media
      • Product videos
        • List product videos
        • Show product video details
      • Translated products
        • List products for a given locale
        • List products by IDs for a given locale
        • List products by tags for a given locale
        • List available tags for a given locale
        • List products by search term for a given locale
        • Show product details for a given locale
        • List product cross-sells for a given locale
        • List cross-selling products for a given locale
      • Translated variation products
        • Show variation product details for a given locale
        • Show variation details for a given locale
      • Variation products
        • Show variation product details
        • Show variation details
    • Shop API
      • Feature assignments
        • List feature assignments
        • Show feature assignment details
      • Languages
        • Show language details
        • List languages
        • List supported languages
      • Legal
        • Show legal details
        • Update legal resource partially (json)
        • List legal content
        • Show legal content details
        • Show legal content details for a given locale
        • Update legal content
      • Locations
        • Create location
        • List locations
        • Show location details
        • Update location
        • Delete location
      • Shop
        • Show shop details
        • Update shop partially (json)
      • Shop address
        • Show address details
        • Update address partially (json)
      • Shop attributes
        • Create shop attribute
        • List shop attributes
        • Show shop attribute details
        • Update shop attribute
        • Delete shop attribute
      • Shop images
        • Create shop image
        • List shop images
        • Find shop images by label
        • Show shop image details
        • Upload shop image
        • Delete shop image
    • Storefront App Data API
      • Newsletter targets
        • Create newsletter target
        • Show newsletter target details
        • Update newsletter target
        • Delete newsletter target
      • Script tags
        • Create script tag
        • List script tags
        • Show script tag details
        • Update script tag
        • Delete script tag
    • Webhook API
      • Webhook subscriptions
        • Introduction
        • Create webhook subscription
        • List webhook subscriptions
        • Show webhook subscription details
        • Update webhook subscription
        • Activate webhook subscription
        • Deactivate webhook subscription
        • Delete webhook subscription
        • List failed webhook deliveries
        • Retry failed webhook delivery
        • Delete webhook delivery failure
      • Example callbacks
        • Order events callback
        • Product events callback
        • Shop events callback
        • App events callback

Cookie settings

Our website uses cookies to improve your user experience. Some cookies are required for the basic functionality of the website while other cookies help us to improve our content and layout. You can agree to all cookies by selecting "Accept all" or you can select "Accept required" to confirm only the required ones. Further information can be found in our Data protection declaration.
Accept required Accept all
ePages Logo
  • Docs
  • ·
  • Blog
  • ·
  • Jobs
  • © 2025 ePages GmbH
  • ·
  • Pilatuspool 2
  • ·
  • 20355 Hamburg
  • ·
  • Germany
  • ·
  • +49-40-350 188-0

  • Contact
  • ·
  • Terms & Conditions
  • ·
  • Legal Notice
  • ·
  • Data Privacy Protection
  • ·
  • Release Notes