LOCURAAPI Reference

OpenAPI 3.1.0

LOCURA Tracker API

API monitoringu przesyłek, wyjątków oraz integracji sklepów i ERP.

Version
1.0.0
Operations
11
Server
https://tracker.locura.tech
Download JSON

Showing 11 of 11 operations

post/api/v1/exceptions/{id}/acknowledge

Potwierdzenie obsługi wyjątku

ExceptionsBearer API key
Schema details

Parameters

[
  {
    "in": "path",
    "name": "id",
    "required": true,
    "schema": {
      "type": "integer"
    }
  }
]

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/health

Stan aplikacji, SQLite i pollera

SystemBearer API key
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
post/api/v1/imports

Import CSV lub XLSX

ImportsBearer API key
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
post/api/v1/ingest/orders

Automatyczny ingest zamówienia ze sklepu lub ERP

IntegrationsBearer API key
Schema details

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "properties": {
          "callback_url": {
            "format": "uri",
            "type": "string"
          },
          "carrier": {
            "enum": [
              "ups",
              "dhl"
            ],
            "type": "string"
          },
          "source_order_id": {
            "type": "string"
          },
          "source_system": {
            "type": "string"
          },
          "tracking_number": {
            "type": "string"
          }
        },
        "required": [
          "source_system",
          "source_order_id",
          "tracking_number",
          "carrier"
        ],
        "type": "object"
      }
    }
  },
  "required": true
}

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/poll-runs

Historia przebiegów pollera

OperationsBearer API key
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/shipments

Lista przesyłek

ShipmentsBearer API key
Schema details

Parameters

[
  {
    "in": "query",
    "name": "view",
    "schema": {
      "enum": [
        "all",
        "active",
        "delivered",
        "exceptions",
        "changed"
      ],
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "carrier",
    "schema": {
      "enum": [
        "ups",
        "dhl"
      ],
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "status",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "q",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "page",
    "schema": {
      "default": 1,
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "per_page",
    "schema": {
      "default": 25,
      "type": "integer"
    }
  }
]

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
post/api/v1/shipments

Dodanie przesyłki

ShipmentsBearer API key
Schema details

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "properties": {
          "carrier": {
            "enum": [
              "ups",
              "dhl"
            ],
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "poll_priority": {
            "maximum": 5,
            "minimum": 0,
            "type": "integer"
          },
          "reference": {
            "type": "string"
          },
          "tracking_number": {
            "type": "string"
          }
        },
        "required": [
          "tracking_number"
        ],
        "type": "object"
      }
    }
  },
  "required": true
}

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/shipments/{id}

Szczegóły i oś czasu

ShipmentsBearer API key
Schema details

Parameters

[
  {
    "in": "path",
    "name": "id",
    "required": true,
    "schema": {
      "type": "integer"
    }
  }
]

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
patch/api/v1/shipments/{id}

Priorytet i odczyt zmiany

ShipmentsBearer API key
Schema details

Parameters

[
  {
    "in": "path",
    "name": "id",
    "required": true,
    "schema": {
      "type": "integer"
    }
  }
]

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
post/api/v1/shipments/{id}/refresh

Ręczne odświeżenie z budżetem

ShipmentsBearer API key
Schema details

Parameters

[
  {
    "in": "path",
    "name": "id",
    "required": true,
    "schema": {
      "type": "integer"
    }
  }
]

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/usage

Budżety API i KPI przesyłek

OperationsBearer API key
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}