Aller au contenu principal

Api des marchés

Vous trouverez ici toute l'api relative à la gestion de votre marché. Nous essayons de la maintenir à jour et de vous fournir les informations les plus précises possibles.

API docs by Redocly

Markets (1.0.0)

Download OpenAPI specification:Download

Gestion des ventes

Sales

path Parameters
slug
required
string
Example: nasa

Responses

Response samples

Content type
application/json
[]

Sale

path Parameters
slug
required
string
Example: simde
sale-slug
required
string
Example: simde-dsqds

Responses

Response samples

Content type
application/json
{}

Sale stats

path Parameters
slug
required
string
Example: jordi-nitzsche
sale-slug
required
string
Example: blanditiis-qui-in-in

Responses

Response samples

Content type
application/json
{
  • "stats": [
    ],
  • "overview": {
    }
}

Gestion des ventes > Invites

Delete invite

Responses

Invite

path Parameters
slug
required
string
Example: sven-mills
sale-slug
required
string
Example: consequatur-facilis-aut-veritatis-sed
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Gestion des ventes > Orders

Sale orders

path Parameters
slug
required
string
Example: nasa
sale-slug
required
string
Example: nasa-edition-2023

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Orders search email

path Parameters
slug
required
string
Example: comedmus
sale-slug
required
string
Example: comedmus-interferences
query Parameters
by
string
Example: by=email
q
string
Example: q=tom.jumel
cached
integer
Example: cached=0

Responses

Send new confirmation email

path Parameters
slug
required
string
Example: nasa
order
required
string
Example: order-6581da2131148

Responses

Response samples

Content type
application/json
{
  • "message": "Email sent"
}

Force payment to be rechecked by service

path Parameters
slug
required
string
Example: nasa
order
required
string
Example: order-6581dbfdf197f

Responses

Response samples

Content type
application/json
{
  • "message": "Email sent"
}

Refund payment

path Parameters
slug
required
string
Example: picasso
order
required
string
Example: order-661d2b04ee011

Responses

Response samples

Content type
application/json
{
  • "message": "Email sent"
}

Accees temporaire

Access

path Parameters
asso
required
string
Example: comedmus

Responses

Delete access

path Parameters
asso
required
string
Example: comedmus
id
required
integer
Example: 2

Responses

Session de scan

List scan sessions

path Parameters
asso
required
string
Example: nasa

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create scan session

path Parameters
asso
required
string
Example: oenologie
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "sale_id": 6,
  • "name": "Porte A-1",
  • "multiple": true,
  • "hook_url": null,
  • "hook_transformer": null,
  • "state": "open",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "sale_id": 10,
  • "multiple": true,
  • "hook_url": null,
  • "hook_transformer": null,
  • "state": "open",
  • "metadata": [ ],
  • "updated_at": "2024-01-12T16:11:16.000000Z",
  • "created_at": "2024-01-12T16:11:16.000000Z",
  • "id": 1
}

Get session

path Parameters
asso
required
string
Example: lavoieduhoublon
id
required
integer
Example: 40

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patch scan sessions

path Parameters
asso
required
string
Example: oenologie
id
required
integer
Example: 9
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "sale_id": 12
}

Delete scan session

path Parameters
asso
required
string
Example: comedmus
id
required
string

Responses

Listes d'adhesion

List memberships

path Parameters
asso
required
string
Example: simde

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create memberships

path Parameters
asso
required
string
Example: simde
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "Cotisations tests",
  • "description": "Test pour les cotisations",
  • "price": 0
}

Response samples

Content type
application/json
{
  • "name": "Cotisations tests",
  • "description": "Test pour les cotisations",
  • "price": 0,
  • "market_id": 3,
  • "updated_at": "2024-03-16T18:35:37.000000Z",
  • "created_at": "2024-03-16T18:35:37.000000Z",
  • "id": 2,
  • "market": {
    }
}

Get memberships and emails in

path Parameters
asso
required
string
Example: simde
id
required
integer
Example: 3

Responses

Response samples

Content type
application/json
{
  • "id": 3,
  • "name": "Cotisations tests",
  • "description": "Test pour les cotisations",
  • "price": "0.00",
  • "market_id": 3,
  • "created_at": "2024-03-16T18:38:50.000000Z",
  • "updated_at": "2024-03-16T18:38:50.000000Z",
  • "emails": [
    ]
}

Patch scan sessions

path Parameters
asso
required
string
Example: simde
id
required
integer
Example: 2
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "Cotisation autres"
}

Response samples

Content type
application/json
{
  • "id": 2,
  • "name": "Cotisation autres",
  • "description": "Test pour les cotisations",
  • "price": "0.00",
  • "market_id": 3,
  • "created_at": "2024-03-16T18:35:37.000000Z",
  • "updated_at": "2024-03-16T18:36:54.000000Z"
}

Delete scan session

path Parameters
asso
required
string
Example: simde
id
required
integer
Example: 2

Responses

Listes d'adhesion > Emails in memberships

Add email

path Parameters
asso
required
string
Example: simde
id
required
integer
Example: 3
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "test@assos.com",
  • "start_date": "2024-05-01",
  • "end_date": null
}

Response samples

Content type
application/json
{
  • "user_email": "test@assos.com",
  • "start_date": "2024-05-01T00:00:00.000000Z",
  • "end_date": null,
  • "membership_id": 3,
  • "updated_at": "2024-03-16T18:52:40.000000Z",
  • "created_at": "2024-03-16T18:52:40.000000Z",
  • "id": 1
}

Remove email

path Parameters
asso
required
string
Example: simde
id
required
integer
Example: 3
row_id
required
integer
Example: 1

Responses

Response samples

Content type
text/plain
null

Moyen de paiement

Payment methods

path Parameters
asso
required
string

Responses

Gestion des ventes > Sale editing

Create sale

path Parameters
slug
required
string
Example: galaking
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "Souvenir du Gala P24",
  • "allowed_methods": [
    ],
  • "targets": [
    ],
  • "short_description": "Repars avec un magnifique souvenir du Gala !",
  • "description": "Repars avec un magnifique souvenir du Gala !\\n",
  • "images": [],
  • "categories": [
    ],
  • "visibility": {
    },
  • "open": {
    },
  • "groups": [
    ]
}

Response samples

Content type
application/json
[]

UnSync providers

path Parameters
slug
required
string
Example: nasa
sale-slug
required
string
Example: nasa-edition-2023

Responses

Response samples

Content type
application/json
{}

Archive sale

path Parameters
slug
required
string
Example: jordi-nitzsche
sale-slug
required
string
Example: blanditiis-qui-in-in

Responses

Response samples

Content type
application/json
{}

restore sale

path Parameters
slug
required
string
sale-slug
required
string

Responses

Response samples

Content type
application/json
{}

Delete sale

path Parameters
slug
required
string
Example: nasa
sale-slug
required
string
Example: nasa-edition-2023

Responses

Response samples

Content type
application/json
{}

Sync providers

path Parameters
slug
required
string
Example: simde
sale-slug
required
string
Example: text-options

Responses

Response samples

Content type
application/json
{}

Add image

path Parameters
slug
required
string
Example: {{market}}
sale-slug
required
string
Example: {{sale_slug}}
Request Body schema: multipart/form-data
image
string <binary>
banner
integer

Responses

Response samples

Content type
application/json
{}

Add image Copy

path Parameters
slug
required
string
Example: {{market}}
sale-slug
required
string
Example: {{sale_slug}}

Responses

Response samples

Content type
application/json
{}

General

Get market overview

path Parameters
slug
required
string
Example: comedmus

Responses

Response samples

Content type
application/json
{
  • "ordered_items": [ ],
  • "last_items": [ ],
  • "month_stats": [
    ]
}

Get configuration

path Parameters
slug
required
string
Example: comedmus

Responses

Response samples

Content type
application/json
{
  • "ordered_items": [ ],
  • "last_items": [ ],
  • "month_stats": [
    ]
}