Orders

Update order invoice information

Update customer invoice tracking information for an order.

patch/admin/orders/{order_id}/invoice

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/orders/{order_id}/invoice
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required
Example:fa729dda-0d62-459f-a89a-f00279de7bfc

Request body

customer_invoice_idstring nullable
customer_invoice_source'STRIPE' | 'BILL_COM' | 'WIRE' nullable
customer_invoice_urlstring nullable

Example request

{
  "customer_invoice_id": "INV-2024-001",
  "customer_invoice_source": "STRIPE",
  "customer_invoice_url": "https://invoice.stripe.com/i/acct_1234567/test_YWNjdF"
}

Response

Order invoice information updated successfully

idstring uuid required
profile_idstring uuid nullable required
client_idstring uuid nullable required
checkout_by_idstring uuid nullable required
team_idstring uuid nullable required
totalnumber nullable required
subtotalnumber nullable required
processing_feenumber nullable required
discountnumber nullable required
credits_appliednumber nullable required
couponstring nullable required
client_secretstring required
status'CREATED' | 'PAID' | 'CANCELLED' required
reference_numberstring nullable required
external_reference_numberstring nullable required
customer_invoice_idstring nullable required
customer_invoice_source'STRIPE' | 'BILL_COM' | 'WIRE' nullable required
customer_invoice_urlstring nullable required
is_guest_orderboolean required
guest_emailstring email nullable required
account_owner_emailstring email nullable required
guest_stripe_customer_idstring nullable required
checkout_session_idstring nullable required
payment_intent_idstring nullable required
payment_status'NOT_STARTED' | 'OPEN' | 'PROCESSING' | 'FAILED' | 'EXPIRED' | 'PAID' required
posthog_distinct_idstring nullable required
metadataobject nullable required

Example response

{
  "total": 55.95,
  "subtotal": 193.65,
  "processing_fee": 878.19,
  "discount": 166.55,
  "coupon": "AMAZING50",
  "client_secret": "cs_test_a1b2c3d4e5f6_secret_YvoWs3BcRC8REQSwuDDe8yg6b",
  "status": "CREATED",
  "reference_number": "PC12345678",
  "external_reference_number": "PC12345678",
  "customer_invoice_id": "INV-2024-001",
  "customer_invoice_source": "STRIPE",
  "customer_invoice_url": "https://invoice.stripe.com/i/acct_1234567/test_YWNjdF",
  "guest_email": "payer@example.com",
  "account_owner_email": "owner@example.com",
  "guest_stripe_customer_id": "cus_1234567890",
  "checkout_session_id": "cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "payment_intent_id": "pi_3PgV8XEA5tKCd21d27zsD8x",
  "payment_status": "NOT_STARTED",
  "metadata": {
    "some_field": "decet"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.