Orders

Amend an order with batch operations

Apply multiple amendments to an order in a single transaction. Supports adding, updating, and removing line items. Order totals will be recalculated.

post/admin/orders/{order_id}/amend

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}/amend
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required
Example:ebd08f5a-8c55-496a-9128-d5f8f6fe6bf3

Request body

discountnumber nullable

Optional manual discount to apply (overrides existing manual discount)

Example request

{
  "amendments": [
    {
      "id": "fae730bb-13f1-4cab-838d-4505eff6191b",
      "product_id": "35b9d926-cb64-4600-86dc-8e373e4e6b5b",
      "quantity": 1,
      "price": 150,
      "internal_cost": 100,
      "action": "add"
    }
  ],
  "discount": 200
}

Response

Order amended successfully

addednumber required
updatednumber required
removednumber required

Example response

{
  "order": {
    "total": 121.09,
    "subtotal": 46.9,
    "processing_fee": 915.35,
    "discount": 12.79,
    "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": "aegrus"
    }
  },
  "added": 1
}

Changes

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