Skip to main content
Submit order validation result
curl --request POST \
  --url https://api.maple.inc/v1/orders/{orderId}/validation_result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "valid",
  "partner_reference": "<string>",
  "warnings": [
    "<string>"
  ]
}
'
{
  "object": "order_validation",
  "id": "<string>",
  "livemode": true,
  "created": 123,
  "order": "<string>",
  "expires_at": 123,
  "partner_reference": "<string>",
  "reason": {
    "code": "<string>",
    "explanation": "<string>",
    "item_external_ids": [
      "<string>"
    ]
  },
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.

Path Parameters

orderId
string
required

Body

application/json
status
enum<string>
required
Available options:
valid
partner_reference
string | null
warnings
string[] | null

Response

Success

object
enum<string>
required
Available options:
order_validation
id
string
required
livemode
boolean
required
created
required
order
string
required
status
enum<string>
required
Available options:
pending,
valid,
invalid,
expired
expires_at
required
partner_reference
string | null
required
reason
object
required
warnings
string[]
required