Account
Il contratto dietro le tue credenziali: chi sei, il tuo credito, i tuoi limiti e le funzioni abilitate.
Get account and key information
In arrivo Il contratto è pubblicato prima dell'implementazione. Questa operazione non è ancora disponibile e la sua forma può ancora cambiare.
Returns the contract the API key belongs to: validity, limits, remaining prepaid credit, test or live mode, and the reserved features enabled for you. The API key itself is never returned (only its last four characters).
Autenticazione: la tua chiave API nell'header X-API-Key.
Risposte
200Account information.Account401Missing, invalid or expired API key. Codes:API_KEY_MISSING,API_KEY_INVALID,API_KEY_EXPIRED.Error403Authenticated but not allowed. Codes:FEATURE_NOT_ENABLED(reserved feature not enabled for the customer),IP_NOT_ALLOWED(the key is restricted to other addresses),ACCOUNT_INACTIVE,CUSTOMER_OUT_OF_SCOPE.Error410Version retired. CodeVERSION_RETIRED.Error429Daily or burst limit exceeded. CodeDAILY_LIMIT_EXCEEDEDorRATE_LIMIT_EXCEEDED. WaitRetry-Afterseconds.Error500Unexpected error. CodeSERVER_ERROR;details.correlation_idrepeats the correlation id.Error502The carrier or an internal dependency failed. CodeUPSTREAM_ERROR. Safe to retry reads; retry writes with the sameIdempotency-Key.Error
Richiesta
Caricamento...
Risposta 200
{
"client_name": "Example S.r.l.",
"api_key_last4": "9f3a",
"activated_on": "2026-01-01",
"expires_on": "2026-12-31",
"allowed_ips": null,
"daily_call_limit": null,
"fast_quote": false,
"prepaid_credit": {
"amount": "125.00",
"currency": "EUR"
},
"livemode": true,
"notify_sender_by_email": true,
"waybill_webhook_url": null,
"features": [
"order-direct"
]
}Modelli
Oggetti usati dalle richieste e dalle risposte di questa pagina.
ParceLabsVersion
CorrelationId
KeyLocale
Account
- Name
client_name- Type
- string
- obbligatorio
- Alias italiano:
cliente - Description
Customer the API key belongs to.
- Name
api_key_last4- Type
- string
- Alias italiano:
chiave_ultime4 - Description
Last four characters of the API key. The full key is never returned.
- Name
activated_on- Type
- string (date)
- Alias italiano:
attivazione - Description
Contract activation date.
- Name
expires_on- Type
- string (date)
- Alias italiano:
scadenza - Description
Contract expiry date.
- Name
allowed_ips- Type
- array of string · nullable
- Alias italiano:
ip_access - Description
IP addresses allowed to call the API with this key.
nullmeans no restriction.
- Name
daily_call_limit- Type
- integer · nullable
- Alias italiano:
limite_giornaliero - Description
Daily limit on quotation calls.
nullmeans unlimited.
- Name
fast_quote- Type
- boolean
- Alias italiano:
fast_quote - Description
Fast quotation enabled.
- Name
prepaid_credit- Type
- Money
- obbligatorio
- Alias italiano:
credito_prepagato - Description
Remaining prepaid credit used by shipment purchases.
- Name
livemode- Type
- boolean
- obbligatorio
- Alias italiano:
live - Description
false: shipment purchases are simulated and charge no credit.
- Name
notify_sender_by_email- Type
- boolean
- Alias italiano:
email_ordine_mittente - Description
Send the order confirmation email to the sender.
- Name
waybill_webhook_url- Type
- string (uri) · nullable
- Alias italiano:
ldv_api - Description
Your endpoint that receives the
shipment.waybill_readywebhook.
- Name
features- Type
- array of string
- Alias italiano:
funzionalita - Description
Features enabled for this customer. Operations marked
x-visibility: enabled-customersneed the matching feature;customer-networkgates the reseller functions (customers, credit transfers, balances) whose pages are public. The Order-Faster (S)FTP files belong toorder-faster.
Money
An amount of money. Responses always use this object; requests send a plain number (see MoneyAmount).
- Name
amount- Type
- string
- obbligatorio
- Alias italiano:
importo - Description
Decimal amount as a string with exactly two decimals. Never a float.
- Name
currency- Type
- string
- obbligatorio
- Alias italiano:
valuta - Description
ISO 4217 currency. v1 is EUR only.
Valori ammessi:
EUR.