API Documentation

Integrate custom product mockups and ordering into your application

🔑

Getting Started

To use the Appcessorise API, you'll need an API key. Include this key in the X-API-Key header with every request.

Your API Password

appcessorise_secure_api_2024

For affiliate tracking, append your affiliate code: appcessorise_secure_api_2024_AFF-000001

Base URL: https://your-domain.com/api/v1

POST /api/v1/mockups

Generate Product Mockup

Create a mockup of a product with a custom image uploaded by your user.

Request Headers

Content-Type: application/json
X-API-Key: appcessorise_secure_api_2024_AFF-000001

Request Body

{
  "product_id": 71,
  "variant_id": 4012,
  "image_url": "https://example.com/user-image.jpg",
  "shipping_address": {
    "country": "US",
    "state": "CA",
    "zip": "90210"
  },
  "third_party_app_name": "YourApp",
  "third_party_order_id": "order_123"
}

Response (200 OK)

{
  "success": true,
  "mockup_id": "abc123def456",
  "mockup_image_url": "https://example.com/mockups/generated.jpg",
  "product_name": "Unisex Staple T-Shirt",
  "base_price": 19.99,
  "estimated_shipping": 5.99,
  "total_price": 25.98,
  "checkout_url": "https://your-domain.com/checkout/abc123def456"
}
POST /api/v1/orders

Create Order

Create an order after payment has been processed. Requires a valid mockup_id from the mockups endpoint.

Request Headers

Content-Type: application/json
X-API-Key: appcessorise_secure_api_2024_AFF-000001

Request Body

{
  "mockup_id": "abc123def456",
  "payment_intent_id": "pi_stripe_payment_id",
  "shipping_address": {
    "name": "John Doe",
    "email": "john@example.com",
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90210",
    "country": "US",
    "phone": "+1234567890"
  }
}

Response (201 Created)

{
  "success": true,
  "order_number": "APP-20240001",
  "printful_order_id": 12345678,
  "estimated_delivery": "2024-12-01",
  "tracking_url": null
}

Error Codes

401 Unauthorized

Missing or invalid API key

400 Bad Request

Missing required parameters or invalid request format

404 Not Found

Resource not found (e.g., invalid mockup_id)

422 Unprocessable Entity

Validation error or unable to process request

500 Internal Server Error

Server error - contact support if this persists

Integration Flow

1

User Uploads Image

Your application allows users to upload a custom image for their product

2

Generate Mockup

Call POST /api/v1/mockups with the image URL and product details to generate a mockup

3

Show Preview & Checkout

Display the mockup to your user or redirect them to our checkout URL

4

Process Payment

Handle payment through Stripe (or use our checkout URL)

5

Create Order

Call POST /api/v1/orders with the mockup_id and shipping details to fulfill the order

6

Order Fulfillment

We handle production and shipping. Tracking updates are sent via webhooks (optional)

Need Help?

Have questions about the API? Need help with integration? We're here to support you.