01.software Docs

getOrderByPayment

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
GET
/api/orders/by-payment

sk01_ read only, PAT/customer/session denied. Tenant-scoped full depth-populated Order and Transaction; missing IDs are 400, duplicates/missing linkage 409.

Authorization

serverSecretKey
headerAuthorizationBearer <token>

Public integration credential: opaque sk01_ secret API key only; PAT and Customer JWT are not supported by this scheme. Requires tenant binding and the read or write scope named by the operation.

Query Parameters

pgProvider*string
Length1 <= length
pgPaymentId*string
Length1 <= length

Response Body

Actual shaped success body

application/json
  1. response
order*

Actual authenticated Payload Order document. Relationship depth and field access vary. This is server-only legacy wire, not the canonical public DTO or a browser discovery promise.

transaction*

Actual authenticated Payload Transaction document. Relationship depth and field access vary. This is server-only legacy wire, not the canonical public DTO or a browser discovery promise.

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X GET 'https://api.01.software/api/orders/by-payment?pgProvider=string&pgPaymentId=string'
Example Response
{  "order": {    "id": "string",    "createdAt": "string",    "updatedAt": "string",    "orderNumber": "string",    "status": "string",    "financialStatus": "string",    "totalAmount": 0,    "currency": "string",    "customerSnapshot": {      "name": "string",      "email": "string",      "phone": "string"    },    "shippingAddress": {      "countryCode": "string",      "regionCode": "string",      "postalCode": "string",      "address": "string",      "detailAddress": "string",      "deliveryMessage": "string",      "recipientName": "string",      "phone": "string"    }  },  "transaction": {    "id": "string",    "createdAt": "string",    "updatedAt": "string",    "order": "string",    "amount": 0,    "status": "string",    "type": "string",    "pgPaymentId": "string",    "pgProvider": "string"  }}