Orders

Order operations

Get Orders List

get

Returns a list of physical orders for the current user with pagination

Autorizações

ApiKeyAuth

Api-KeystringObrigatório

API key for authentication.

Parâmetros de consulta

lastOrderIdstringOpcional

ID of the last order for cursor pagination

limitinteger · máx: 50Opcional

Number of records per page (maximum 50)

Default: 50

pageintegerOpcional

Page number

Default: 1

Respostas

200

Successful response

application/json

400

Bad request (invalid status)

application/json

401

Unauthorized (invalid API key)

application/json

get/physical/orders

HTTPcURLJavaScriptPython

GET /api/v1/physical/orders HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "rows": [
    {
      "id": 12345,
      "status": "pending",
      "created": "2024-01-15T10:30:00Z",
      "fullName": "John Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "telegramID": 123456789,
      "address": {
        "countryIso2": "US",
        "countryIso3": "USA"
      },
      "locality": "New York",
      "fullAddress": "USA, New York, 5th Avenue, 123, Apt 45",
      "customerNote": "Please call before delivery",
      "items": [
        {
          "id": 567,
          "price": 150,
          "quantity": 2,
          "currency": "usd",
          "name": "T-shirt with print",
          "attributes": {
            "size": "L",
            "color": "Black"
          }
        }
      ],
      "deliveryCost": 25.5,
      "currency": "usd"
    }
  ],
  "meta": {
    "total": 125,
    "offset": 1,
    "limit": 50
  }
}

Get Order Details

get

Returns detailed information about a specific order

Autorizações

ApiKeyAuth

Api-KeystringObrigatório

API key for authentication.

Parâmetros de rota

idintegerObrigatório

Order ID

Respostas

200

Successful response

application/json

idintegerObrigatório

Unique order identifier

Example: 12345

statusstring · enumObrigatório

Order status

Example: pendingValores possíveis:

createdstring · date-timeObrigatório

Order creation date and time

Example: 2024-01-15T10:30:00Z

fullNamestringObrigatório

Recipient full name

Example: John Doe

emailstring · emailObrigatório

Recipient email

Example: [e-mail]

phonestringObrigatório

Recipient phone

Example: [phone]

telegramIDinteger · int64Obrigatório

Buyer's Telegram ID

Example: 123456789

localitystringObrigatório

City

Example: New York

fullAddressstringObrigatório

Full delivery address

Example: USA, New York, 5th Avenue, 123, Apt 45

customerNotestringObrigatório

Customer note

Example: Please call before delivery

deliveryCostnumber · floatObrigatório

Delivery cost

Example: 25.5

currencystringObrigatório

Order currency

Example: usd

400

Bad request (order ID not provided)

application/json

401

Unauthorized (invalid API key)

application/json

404

Order not found

application/json

get/physical/orders/{id}

HTTPcURLJavaScriptPython

GET /api/v1/physical/orders/{id} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 12345,
  "status": "pending",
  "created": "2024-01-15T10:30:00Z",
  "fullName": "John Doe",
  "email": "[e-mail]",
  "phone": "[phone]",
  "telegramID": 123456789,
  "address": {
    "countryIso2": "US",
    "countryIso3": "USA"
  },
  "locality": "New York",
  "fullAddress": "USA, New York, 5th Avenue, 123, Apt 45",
  "customerNote": "Please call before delivery",
  "items": [
    {
      "id": 567,
      "price": 150,
      "quantity": 2,
      "currency": "usd",
      "name": "T-shirt with print",
      "attributes": {
        "size": "L",
        "color": "Black"
      }
    }
  ],
  "deliveryCost": 25.5,
  "currency": "usd"
}