Kör flera anrop

POST/api/v1/batch

Upp till 500 anrop i ett, i tur och ordning. Bra för att läsa in historik: kunder, produkter och ordrar.

Varje operation är ett vanligt anrop under /api/v1 – metod, sökväg och kropp – och kontrolleras och körs precis som om det skickats för sig: med nyckelns behörigheter och samma fel. Svaren kommer i samma ordning, med status och kropp för var och en. En operation som misslyckas stoppar inte de andra.

Hela batchen räknas som ett anrop mot gränsen per minut, men högst 20 batchar per minut och nyckel. Upsert med PUT gör det tryggt att köra om en batch som avbröts; med Idempotency-Key får en omsänd batch samma svar utan att köras igen.

Batch och idempotens →

Behörighet

Alla giltiga nycklar.

Kropp

JSON, Content-Type: application/json. Okända fält ger 422.

operationsarray<object>krävs: Operationerna (högst 500), som körs i tur och ordning.minst 1 · högst 500 st
operations[].methodstringkrävs: GETPOSTPUTPATCHDELETE
operations[].pathstringkrävs: Sökvägen under /api/v1, med query om anropet har en.minst 1 tecken · högst 2048 tecken
operations[].bodyobject<valfritt>: Anropets kropp, som ett JSON-objekt.

Göra om anropet

Skicka gärna headern Idempotency-Key (t.ex. ett uuid). Skickas samma anrop igen med samma nyckel inom 24 timmar kommer det första svaret tillbaka, utan att något görs två gånger. Batch och idempotens

Svar

200 Svaren, i samma ordning som operationerna.

resultsarray<object>krävs
results[].statusintegerkrävs: Operationens HTTP-status.
results[].bodyvalfrittkrävs: Operationens svar: det vanliga svaret, ett fel (problem+json) eller null (204).
succeededintegerkrävs
failedintegerkrävs

Fel

400: bad_request
401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
409: idempotency_in_progress
415: unsupported_media_type
422: validation_failed idempotency_key_reused
429: rate_limited
500: internal_error

Anrop

curl -X POST 'https://newsletter.qrona.se/api/v1/batch' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operations":[{"method":"PUT","path":"/stores/butik-se/products/731","body":{"title":"T-shirt i ekologisk bomull","variants":[{"id":"731-blue-m","title":"Blå, M","price":249}]}},{"method":"PUT","path":"/stores/butik-se/orders/50087","body":{"customer":{"id":"1042","email":"anna@example.se"},"order_total":548,"processed_at":"2024-11-29T10:12:00Z","lines":[{"id":"1","product_id":"731","quantity":2,"price":249}]}}]}'

Svar 200

{
  "results": [
    {
      "status": 201,
      "body": {
        "id": "50087",
        "financial_status": "paid",
        "order_total": 548
      }
    },
    {
      "status": 422,
      "body": {
        "type": "https://newsletter.qrona.se/developer/api/errors#validation_failed",
        "status": 422,
        "code": "validation_failed",
        "errors": [
          {
            "field": "lines",
            "message": "En order har minst en rad."
          }
        ]
      }
    }
  ],
  "succeeded": 1,
  "failed": 1
}