Post-Purchase Checkout

POST https://partner.getmulberry.com/api/post-purchase-checkout

Converts a post-purchase eligible order into a full warranty order, attaching one or
more warranties to line items after the original sale. The retailer collects
payment for the warranty themselves and calls this endpoint to complete the
issuance.

HTTP method: POST

Authentication: Private Bearer Token

Staging endpoint: https://partner-staging.getmulberry.com/api/post-purchase-checkout

Production endpoint: https://partner.getmulberry.com/api/post-purchase-checkout

Prerequisites

Before calling this endpoint, the order must have been submitted to
POST /api/carts without a warranty. That submission creates a order
and automatically generates warranty offers for each line item.

Body Parameters

line_items object

Each entry in line_items must include either product_id / variant_id
or warranty_offer_id.

Headers

Request Examples

Attach by product_id (recommended)

{
  "id": "ORDER-12345",
  "line_items": [
    { "product_id": "SOFA-001" }
  ]
}

Attach by warranty_offer_id

{
  "id": "ORDER-12345",
  "line_items": [
    { "warranty_offer_id": "d177c5c3-e549-416f-b048-db0e7ac46758" }
  ]
}

Multiple line items

{
  "id": "ORDER-12345",
  "line_items": [
    { "product_id": "SOFA-001" },
    { "product_id": "CHAIR-002" }
  ]
}

cURL

curl --request POST \
  --url https://partner-staging.getmulberry.com/api/post-purchase-checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "ORDER-12345",
    "line_items": [
      { "product_id": "SOFA-001" }
    ]
  }'

Responses

200 — Success

A warranty order was created. The response contains the internal Mulberry order ID.

{
  "id": "3af6dd3b-1234-5678-abcd-ef0123456789"
}

400 — Bad Request

Returned when:

• A product_id is provided but no warranty offer exists for that product on
  the order.
  JSON

  { "error": "No warranty offer found for product SOFA-001 on order ORDER-12345." }

• A line item contains neither warranty_offer_id nor product_id / variant_id.
  JSON

  { "error": "Each line item must include either a warranty_offer_id or a product_id/variant_id to identify the warranty offer." }

• line_items is empty or the payload fails schema validation.

404 — Not Found

No order exists for the given id and authenticated retailer.

{ "error": "Existing vagrant order not found." }

500 — Internal Server Error

The order could not be created. Contact support if this persists.

{ "error": "Failed post purchase checkout. No order was created." }

Relationship to /api/carts