# Statusy zásilky /shipment ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /codelist/status: get: summary: Statusy zásilky /shipment deprecated: false description: >+ ## Význam a použití Metoda **codelist/status** slouží k získání přehledu definovaných kódů a popisů, které v tomto případě označují stavy zásilek. Díky této metodě lze zjistit, jaké možné stavy se v systému PPL vyskytují (např. "Zásilka připravena k doručení", "Zásilka se dnes doručuje", "Nedoručeno - žádost odesílatele"). Tento číselník je možné využít především pro: **1. Zobrazení stavu zásilky v uživatelském rozhraní** - Pokud je potřeba uživateli (nebo v administraci) ukázat stav balíku, ale zároveň chcete používat oficiální pojmenování od PPL, můžete si tato pojmenování načíst právě z **codelist/status**. **2. **Integrace a mapování**** - V některých systémech (např. e-shop nebo ERP) již existují interní stavy objednávek (třeba Paid, Shipped, Delivered). - Propojení s PPL pak vyžaduje mapování PPL kódů na vaše interní kódy (pokud je chcete sjednotit). - **Codelist/status** pomůže, abyste znali všechny varianty stavů, se kterými se můžete setkat. tags: - API Metody/Codelist - Codelist parameters: - name: Limit in: query description: '' required: true schema: maximum: 1000 minimum: 1 type: integer format: int32 - name: Offset in: query description: '' required: true schema: maximum: 2147483647 minimum: 0 type: integer format: int32 - name: Accept-Language in: header description: 'Language specification, default language: cs-CZ' required: false example: '' schema: $ref: '#/components/schemas/AcceptLanguageSchema' - name: X-Correlation-ID in: header description: Correlation Id of request required: false example: '' schema: $ref: '#/components/schemas/XCorrelationIdSchema' - name: X-LogLevel in: header description: The forced log level required: false example: '' schema: $ref: '#/components/schemas/XLogLevelSchema' responses: '200': description: Success content: application/json: schema: type: array items: type: object x-apidog-refs: 01JKB0E58TTRDGQEWJ5ASDWZWE: $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.Codelist.StatusModel x-apidog-overrides: code: &ref_0 type: string description: Kód nullable: true name: &ref_1 type: string description: Jméno nullable: true required: [] x-apidog-orders: - 01JKB0E58TTRDGQEWJ5ASDWZWE properties: code: *ref_0 name: *ref_1 x-apidog-ignore-properties: - code - name headers: X-Correlation-ID: description: Correlation Id of request otherwise id of response schema: $ref: '#/components/schemas/XCorrelationIdSchema' X-Paging-Total-Items-Count: description: Total items in result schema: $ref: '#/components/schemas/XPagingSchema' X-Paging-Offset: description: Paging offset schema: $ref: '#/components/schemas/XPagingSchema' X-Paging-Limit: description: Page size schema: $ref: '#/components/schemas/XPagingSchema' x-apidog-name: OK '400': description: BadRequest content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJV9W0KC8N7X892W3PB8T1RH x-apidog-refs: 01JJV9W0KC8N7X892W3PB8T1RH: &ref_2 $ref: >- #/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Bad Request '500': description: InternalServerError content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJV9WBQ4PV1XGHWZTG5PHS32 x-apidog-refs: 01JJV9WBQ4PV1XGHWZTG5PHS32: *ref_2 x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Server Error '503': description: ServiceUnavailable content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJV9WHJMWSY2VN2V6V5C8Z76 x-apidog-refs: 01JJV9WHJMWSY2VN2V6V5C8Z76: *ref_2 x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Service Unavailable security: [] x-apidog-folder: API Metody/Codelist x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/796227/apis/api-13465897-run components: schemas: AcceptLanguageSchema: type: string description: Accept-Language header schema x-apidog-folder: '' XCorrelationIdSchema: type: string description: X-Correlation-ID header schema x-apidog-folder: '' XLogLevelSchema: enum: - Trace - Debug - Information - Warning - Error - Critical type: string description: X-LogLevel header schema x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.Codelist.StatusModel: type: object properties: code: type: string description: Code nullable: true name: type: string description: Name nullable: true additionalProperties: false description: Status model x-apidog-orders: - code - name x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: type: string x-apidog-orders: - errors - type - title - status - detail - instance x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: oauth2: type: apikey description: Get access token from authentication server. name: Authorization in: header Bearer: type: jwt description: >- JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}" scheme: bearer bearerFormat: JWT servers: [] security: [] ```