API reference / Sandbox

Create a test buyer with a shipping address; response shippingAddress.id is minted (`addr_*`)

POST/open/v1/sandbox/buyersScope: No data scope

Service Endpoint Seller token not required

Environment	Base URL + Path
Production	`https://open.mallplus.ph/open/v1/sandbox/buyers`
Sandbox	`https://sandbox.open.mallplus.ph/open/v1/sandbox/buyers`

Common Signing and Seller Headers

Header	Type	Required	Rules	Description
X-MallPlus-Partner-Id	string	Yes	Issued client ID for the calling app.	Identifies the partner app whose secret signs the request.
X-MallPlus-Timestamp	integer	Yes	Unix timestamp in seconds; default acceptance window is 90 seconds.	Prevents replay outside the allowed signing window.
X-MallPlus-Signature-Version	string	Yes	Use `3` for HMAC v3.	Selects the request signing algorithm.
X-MallPlus-Nonce	string	Yes	32-64 lowercase hexadecimal characters, unique per request.	Replay-protection nonce included in the v3 signing base string.
X-MallPlus-Signature	string	Yes	HMAC-SHA256 over timestamp, client ID, method, path, canonical query, body hash, and nonce.	Cryptographic proof that the request was signed with the app secret.
X-MallPlus-Access-Token	string	Conditional	Required when the operation says seller token required.	Seller OAuth access token returned by the authorization flow.
X-MallPlus-Seller-Id	string	Conditional	Required when `X-MallPlus-Access-Token` is required.	Seller ID bound to the seller OAuth token.

Parameters

Name	In	Type	Required	Rules	Description
Idempotency-Key	header	string	No	Min length: 1	Recommended UUID per logical operation. Retry with the same key and a byte-identical body. Omitting the header still runs the mutation and sets `X-MallPlus-Idempotency: absent`.

Request Body required

Field	Type	Required	Rules	Description
name	string	Yes	Min length: 1; Max length: 120	Partner-visible name.
email	string<email>	Yes	Format: email; Max length: 254	Email address.
phoneNumber	string	Yes	Min length: 1; Max length: 40	Contact phone number.
shippingAddress	SandboxBuyerShippingAddressRequest	Yes	No additional properties	Shipping address details.
shippingAddress.line1	string	Yes	Min length: 1; Max length: 200	First line of the street address.
shippingAddress.line2	string	No	Max length: 200	Second line of the street address, when present.
shippingAddress.city	string	Yes	Min length: 1; Max length: 100	PSGC-aligned Philippine city or municipality.
shippingAddress.region	string	Yes	Min length: 1; Max length: 100	PSGC-aligned Philippine region.
shippingAddress.postalCode	string	Yes	Min length: 1; Max length: 20	Postal code for the address.
shippingAddress.country	string	Yes	Min length: 2; Max length: 2	ISO 3166-1 alpha-2 country code.

Response Parameters

Success status: HTTP 201

Field	Type	Rules	Description
success	boolean	-	Whether the sandbox buyer request succeeded.
data	SandboxBuyer	No additional properties	Response or event payload for this schema.
data.id	string	-	Sandbox buyer identifier used by sandbox order flows.
data.name	string	-	Display name of the test buyer.
data.email	string<email>	Format: email	Email address assigned to the test buyer.
data.phoneNumber	string	-	Phone number assigned to the test buyer.
data.shippingAddress	SandboxBuyerShippingAddress	No additional properties	Shipping address details.
data.shippingAddress.id	string	-	Server-minted shipping-address identifier. Record this as ADDRESS-1; echoed on the order after place.
data.shippingAddress.line1	string	-	Primary street address line.
data.shippingAddress.line2	string	-	Optional secondary street address line such as unit or floor.
data.shippingAddress.city	string	-	PSGC-aligned Philippine city or municipality.
data.shippingAddress.region	string	-	PSGC-aligned Philippine region.
data.shippingAddress.postalCode	string	-	Postal code for the sandbox buyer shipping address.
data.shippingAddress.country	string	-	ISO 3166-1 alpha-2 country code for the shipping address.
data.createdAt	string<date-time>	Format: date-time	ISO-8601 UTC timestamp when the sandbox buyer was created.
data.updatedAt	string<date-time>	Format: date-time	ISO-8601 UTC timestamp when the sandbox buyer was last updated.

Error Codes

HTTP Status	Schema	Description
400	PlatformError400Response	Validation error, or a missing/malformed required signing header (BAD_REQUEST)
401	PlatformError401Response	Unauthorized — invalid credentials, invalid signature, or expired timestamp (TIMESTAMP_EXPIRED)
403	PlatformError403Response	Forbidden — insufficient scope
409	Unenumerated409ErrorResponse	The request conflicts with the current resource state or reuses an idempotency key
413	PlatformError413Response	The request body exceeds the endpoint payload limit
429	PlatformError429Response	The partner or endpoint rate limit has been exceeded
503	PlatformError503Response	A required platform or upstream dependency is temporarily unavailable

This operation does not declare its own error.code list. Any operation can return the authentication, signing, scope, rate-limit and system codes listed in the Error code reference.

Request Example

curl -X POST "https://sandbox.open.mallplus.ph/open/v1/sandbox/buyers" \
  -H "X-MallPlus-Partner-Id: mp_partner_123" \
  -H "X-MallPlus-Timestamp: 1786924800" \
  -H "X-MallPlus-Signature-Version: 3" \
  -H "X-MallPlus-Nonce: 4f8b9a0c4d5e6f708192a3b4c5d6e7f8" \
  -H "X-MallPlus-Signature: <hex_hmac_sha256>" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "example_name",
  "email": "partner@example.com",
  "phoneNumber": "example_phoneNumber",
  "shippingAddress": {
    "line1": "example_line1",
    "line2": "example_line2",
    "city": "example_city",
    "region": "example_region",
    "postalCode": "example_postalCode",
    "country": "example_country"
  }
}'

Response Example

{
  "success": true,
  "data": {
    "id": "buy_test_contract",
    "name": "Test Buyer",
    "email": "buyer@example.com",
    "phoneNumber": "+639001234567",
    "shippingAddress": {
      "id": "addr_test_contract",
      "line1": "123 Test St",
      "city": "Manila",
      "region": "NCR",
      "postalCode": "1000",
      "country": "PH"
    },
    "createdAt": "2026-08-26T04:00:00.000Z",
    "updatedAt": "2026-08-26T04:00:00.000Z"
  }
}