Skip to main content

Get Orders

GET 
/contracts/orders

This endpoint allows retrieving orders based on filters such as limit, offset, status, and user email.

Request​

Query Parameters

    limit integer

    Limit the number of orders returned. Defaults to 0 if not provided.

    offset integer

    Offset the starting point of orders returned. Defaults to 0 if not provided.

    status string

    Possible values: [FINISHED, IN_PROGRESS]

    Filter orders by status. Possible values are Finished, or In progress

    user_email string

    Filter orders by user email.

Responses​

Ok

Schema
  • Array [
    • id string
    status string

    Possible values: [FINISHED, IN_PROGRESS, ORDER_INIT_AND_WAITING, NOT_PLUGGED, PAYMENT_ERROR, INTERNAL_ERROR, PROVIDER_ERROR]

    amount number
    commision_price number
    tax_price number
    provider string,
    charger object
    _id string
    idPR string
    idCupr number
    lat number
    lon number
    status boolean
    plugs number
    provider string
    connection string
    chargerDetails object[]
  • Array [
    • _id string
    charger string
    name string
    model string
    address string
    town string
    state string
    hasRestaurant boolean
    hasMall boolean
    hasCarWash boolean
    hasParking boolean
    hasGasStation boolean
    hasShop boolean
    hasCoffeeShop boolean
    hasWorkshop boolean
    plusCode string
    accessPrice number
    moreInfo string
    schedule string
    plugs object[]

    All plugs of a charger details

  • Array [
    • _id string
    chargerDetails string
    logicPlugId string
    lastUpdate date-time
    chargeSpeedId number
    provider string
    physicalPlugs object[]

    All physical plugs of a logic plug

  • Array [
    • _id string
    logicPlug string
    physicalPlugId string
    conectorType number
    status boolean
    lastUpdate date-time
    chargeMode number
    maxPower number
    provider string
    price number
  • ]
  • ]
    • provider string
    bookingType number
    bookingTime number
    freeCancelBookingTime number
    createdAt date-time
    updatedAt date-time
    monday string
    tuesday string
    wednesday string
    thursday string
    friday string
    saturday string
    sunday string
  • ]
    • loc string[]
    createdAt date-time
    updatedAt date-time
    show boolean
    physicalPlugs object
    _id string
    logicPlug string
    physicalPlugId string
    conectorType number
    status boolean
    lastUpdate date-time
    chargeMode number
    maxPower number
    provider string
    price number
    plug_id string,
    started date-time
    finished date-time
    email string
    plug_price number
    price_unit string,

    Possible values: [kwh, minute, hour, session, free]

    currency string
    charged_kwh number
    co2_saved number
    battery_level number
    user_email string
    plate string
    external_id string,
    createdAt date-time
    updatedAt date-time
    outlet_number number
    power_kw number
  • ]
Loading...