Invoices

🧾 Manage orders, process refunds, and view transaction details.

List All Invoices

get

List all invoices/orders.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Query parameters

searchstringOptional

statusstringOptional

Responses

200

List of invoices

application/json

get

/invoices

HTTPcURLJavaScriptPython

GET /api_user/api/v1/invoices HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

List of invoices

{
  "success": true,
  "invoices": [
    {
      "id": 5001,
      "invoice_id": "INV-2024-001",
      "customer_email": "[email protected]",
      "total_cents": 4999,
      "currency": "USD",
      "status": "completed",
      "payment_method": "stripe",
      "created_at": "2024-12-20T12:00:00Z",
      "items_count": 1
    }
  ]
}

Get Invoice Details

get

Get details of a specific invoice.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

invoiceIdstringRequired

Numeric ID or Invoice ID (INV-...)

Responses

200

Invoice details

application/json

get

/invoices/{invoiceId}

HTTPcURLJavaScriptPython

GET /api_user/api/v1/invoices/{invoiceId} HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Invoice details

{
  "success": true,
  "invoice": {
    "id": 5001,
    "invoice_id": "INV-2024-001",
    "customer_email": "[email protected]",
    "total_cents": 4999,
    "currency": "USD",
    "status": "completed",
    "payment_method": "stripe",
    "created_at": "2024-12-20T12:00:00Z",
    "items_count": 1,
    "items": [
      {
        "product_id": 1,
        "quantity": 1,
        "price_cents": 1,
        "name": "text"
      }
    ]
  }
}

Mark Invoice as Completed

post

Manually mark an invoice as completed.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

invoiceIdstringRequired

Responses

200

Completed

application/json

post

/invoices/{invoiceId}/complete

HTTPcURLJavaScriptPython

POST /api_user/api/v1/invoices/{invoiceId}/complete HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Completed

{
  "success": true
}

Mark Invoice as Refunded

post

Mark an invoice as refunded.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

invoiceIdstringRequired

Responses

200

Refunded

application/json

post

/invoices/{invoiceId}/refund

HTTPcURLJavaScriptPython

POST /api_user/api/v1/invoices/{invoiceId}/refund HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Refunded

{
  "success": true
}

Replace Invoice Items

patch

Replace the items in an invoice with new ones.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Path parameters

invoiceIdstringRequired

Body

application/json

itemsobject[]Required

Responses

200

Items updated

application/json

patch

/invoices/{invoiceId}/items

HTTPcURLJavaScriptPython

PATCH /api_user/api/v1/invoices/{invoiceId}/items HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "items": [
    {}
  ]
}

200

Items updated

{
  "success": true
}