API docs by Redocly

Nostress API (latest)

Download OpenAPI specification:

Nostress Developers Team: nostress_devs@to-infinity.com

Introduction

This document provide entities schemas allowing you to push masterdata and transactional data in your nostress platform.

We offer 2 modes for data ingestion :

  • CSV files : you have to put files with headers on a provided google cloud storage bucket or on your own SFTP
  • Bigquery ingestion : you share a dataset with nostress team containing each nostress entities as tables

CSV files

  • Flatten file UTF-8 encoded in semicolon or pipe separated values format (“;” or “|”). The separator must be the same for all the files.
  • File names must contain generated data and time to ensured their unicity and chronology. For instance sales_20231201123410.csv.gz
  • First line must contains field headers as described below.
  • Files must be gzipped and have a final .gz extension
  • Each file must contain at most 5,000,000 rows

Bigquery ingestion

  • The customer should share a dataset with nostress team containing each nostress entities as tables, as described follow
  • The format must be one the following bigquery format, depending the indicated type in nostress.io/api · STRING · NUMERIC · INTEGER · BOOLEAN · DATE · TIME · TIMESTAMP
  • Each table must include a field name « ts » TIMESTAMP, containing, CURRENT_TIMESTAMP when row is inserted in. This information is mandatory to ensure that nostress didn’t miss new inserted data after the latest data retrieval, and also to avoid the duplication of fetched data.
  • Ask nostress team to provide the complete bigquery schema in json format
  • The data must deleted after 30 days
POST /input/sales
POST /input/sales
POST /input/traffic

Masterdata

Stores

File store_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Stores lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id

name
required
string[a-zA-Z0-9_\-\s]+$

Store name

bmode
required
string or null (Business mode) [a-zA-Z0-9_\-\s]+$

Business mode. Example : RETAIL, WHOLESALE, OUTLET, FSS, LICENCE. (empty for warehouse)

scope
required
string or null (Scope)
Enum: "MAG" "STORE" "WEB" "MKP" "APP"

Scope/Channel. (empty for warehouse)

country
required
string or null (Country code) ^[A-Z]{2}$

Example : FR, ES, US, BE. (empty for warehouse)

city
required
string or null

City

region_name
required
string or null[a-zA-Z0-9_\-\s]+$

Commercial Region name

is_wh
boolean or null

Is warehouse

supply_zone
string or null[a-zA-Z0-9_\-\s]+$

Logistic Zone Id

is_deported_wh
boolean or null

Is Deported warehouse

is_web
boolean or null

Is digital store

typology
string or null (Typology)

Typology. Example : SUCCURSALE, AFFILIATE, FRANCHISE

is_affiliate
boolean or null

Is Affiliate (to restrict specific access)

street
string or null

Street & number

street_complement
string or null

Street complement

postal_code
string or null

ZIP code

state
string or null (State)

US/Canada State. Example: CA, TX, NY, FL…

zone_name
string or null

Commercial Zone name

localisation
string or null (Localisation)

Localisation : Example : CC, CV, ZAC, BEACH

surface_vente
integer or null

Sales area in m2

latitude
number or null

Latitude Geo

longitude
number or null

Longitude Geo

categorie
string or null (Category)

Store category. Example FLAGSHIP, CITY, SPORT

cluster
string or null (Cluster)

Store Cluster. Example A+, A, B, C

surface_categ
string or null (Sales area category)

Sales area category. Example S, M, L, XL

concept
string or null

Store Concept. Customisable

status
string or null

Store Status : Customisable

restriction
string or null

Access restriction: Customisable (Example : Pass Sanitaire)

email
string or null

Store user email address for Kathy access

photo
string or null

Public Url of the store’s photo

new_store_id
string or null (New Store Id) [a-zA-Z0-9_\-\s]+$

New Store Id : Example : 987654A

s_attr_01
string or null

Custom Attribut 01

s_attr_02
string or null

Custom Attribut 02

s_attr_03
string or null

Custom Attribut 03

s_attr_04
string or null

Custom Attribut 04

s_attr_05
string or null

Custom Attribut 05

s_attr_06
string or null

Custom Attribut 06

s_attr_07
string or null

Custom Attribut 07

s_attr_08
string or null

Custom Attribut 08

s_attr_09
string or null

Custom Attribut 09

s_attr_10
string or null

Custom Attribut 10

s_attr_11
string or null

Custom Attribut 11

s_attr_12
string or null

Custom Attribut 12

s_attr_13
string or null

Custom Attribut 13

s_attr_14
string or null

Custom Attribut 14

s_attr_15
string or null

Custom Attribut 15

s_attr_16
string or null

Custom Attribut 16

s_attr_17
string or null

Custom Attribut 17

s_attr_18
string or null

Custom Attribut 18

s_attr_19
string or null

Custom Attribut 19

s_attr_20
string or null

Custom Attribut 20

s_attr_21
string or null

Custom Attribut 21

s_attr_22
string or null

Custom Attribut 22

s_attr_23
string or null

Custom Attribut 23

s_attr_24
string or null

Custom Attribut 24

s_attr_25
string or null

Custom Attribut 25

s_attr_26
string or null

Custom Attribut 26

s_attr_27
string or null

Custom Attribut 27

s_attr_28
string or null

Custom Attribut 18

s_attr_29
string or null

Custom Attribut 29

s_attr_30
string or null

Custom Attribut 30

secure_01
string or null

Secure Attribut 01

secure_02
string or null

Secure Attribut 02

secure_03
string or null

Secure Attribut 03

secure_04
string or null

Secure Attribut 04

secure_05
string or null

Secure Attribut 05

secure_06
string or null

Secure Attribut 06

secure_07
string or null

Secure Attribut 07

secure_08
string or null

Secure Attribut 08

secure_09
string or null

Secure Attribut 09

secure_10
string or null

Secure Attribut 10

open_since
string or null <date> (Opened since)

First Opening Date

reopened_since
string or null <date> (Re opened since)

Last Opening Date

closed_since
string or null <date> (Closed since)

Closing Date

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Products

File product_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Product Masterdata to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product id

short_desc
string or null

Short description

img
string or null

Product image URL

internal_name
required
string^(?!\s*$).+

Internal name

season
string

Active season

original_season
string

Original season

activity
string or null[a-zA-Z0-9_\-\s]+$

Hierarchical level 0

division
string or null[a-zA-Z0-9_\-\s]+$

Hierarchical level 1

segment
required
string[a-zA-Z0-9_\-\s]+$

Hierarchical level 2

family
string or null

Hierarchical level 3

subfamily
string or null

Hierarchical level 4

theme
string or null

Theme label

model
string or null[a-zA-Z0-9_\-\s]+$

Style Code

model_name
string or null[a-zA-Z0-9_\-\s]+$

Style Name

size_grid
required
string or null

Variant classification group

color
string or null

Color code

lib_color
string or null

Color label

lib_coloris_regroup
string or null

Color group name

stock_ignore
boolean or null

Stock to be ignored (like plastic bags etc…)

revenue_ignore
boolean or null

Revenue to be ignored (like Shipping fees etc…)

seller_bonus
string or null

Seller Bonus

objectif_groupe
string or null

Refer to Badge files

external_id
string or null

product reference on the WEB site

attr_01
string or null

Custom Attribut 01

attr_02
string or null

Custom Attribut 02

attr_03
string or null

Custom Attribut 03

attr_04
string or null

Custom Attribut 04

attr_05
string or null

Custom Attribut 05

attr_06
string or null

Custom Attribut 06

attr_07
string or null

Custom Attribut 07

attr_08
string or null

Custom Attribut 08

attr_09
string or null

Custom Attribut 09

attr_10
string or null

Custom Attribut 10

attr_11
string or null

Custom Attribut 11

attr_12
string or null

Custom Attribut 12

attr_13
string or null

Custom Attribut 13

attr_14
string or null

Custom Attribut 14

attr_15
string or null

Custom Attribut 15

attr_16
string or null

Custom Attribut 16

attr_17
string or null

Custom Attribut 17

attr_18
string or null

Custom Attribut 18

attr_19
string or null

Custom Attribut 19

attr_20
string or null

Custom Attribut 20

attr_21
string or null

Custom Attribut 21

attr_22
string or null

Custom Attribut 22

attr_23
string or null

Custom Attribut 23

attr_24
string or null

Custom Attribut 24

attr_25
string or null

Custom Attribut 25

attr_26
string or null

Custom Attribut 26

attr_27
string or null

Custom Attribut 27

attr_28
string or null

Custom Attribut 18

attr_29
string or null

Custom Attribut 29

attr_30
string or null

Custom Attribut 30

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Variants

File variant_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Variants lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product variant id

product_id
required
string[a-zA-Z0-9_\-\s]+$

Master product code

size
required
string

Size OR Characteristic name

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

GTIN/EAN

File ean_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

GTIN/EAN lines to Create/Update

Array
id
required
string[a-zA-Z0-9]+$

KEY : GTIN/EAN

product_variant_id
required
string[a-zA-Z0-9_\-\s]+$

Product variant id

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Daily Transactions

Stocks

File stock_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode full stock on start of the day, the without zero stocks

Update Key created_on, store_id

Every sundays for historical data

Authorizations:
gcpAuth
Request Body schema:
required

Stocks lines to Create/Update

Array
created_on
required
string <date>

KEY : Inventory date ( on morning )

store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id or warehouse id

product_variant_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product Variant Id

stock_type
required
string[a-zA-Z0-9_\-\s]+$

KEY : Stock Type

stock
required
integer

Stock Quantity

season_id
string or null

Season Id / Collection

seasonality
string or null

Seasonality

plan_cluster
string or null

Cluster (Planned)

real_cluster
string or null

Cluster (Real)

price_type
string or null
Enum: "regular" "clearance" "promo"

Price Type

valst_eur
number or null

Valorisation (company currency)

property name*
additional property
any

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Purchase orders

File po_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Purchase orders lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Purchase order id

product_variant_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product Variant Id

pack_id
string[a-zA-Z0-9_\-\s]+$

KEY : Pack id

created_on
required
string <date>

Order date

qty_cde
required
integer

Ordered quantity

qty_receipt
required
integer

Receipted quantity

pr
required
number

Cost price in Company Currency

laupr
required
number

Launch price Excluding Taxes in Company Currency

type_commande
required
string

Order type

season
required
string

Season Id / Collection

date_livr_upd
required
string <date>

Updated Delivery date

warehouse_id
required
string

Warehouse Id

date_livr_init
string <date>

Initial Delivery date

date_livr_reelle
string <date>

Real Delivery date

date_mad_init
string <date>

Initial Factory date

date_mad_upd
string <date>

Updated Factory date

date_mad_reelle
string <date>

Real Factory date

date_etd_init
string <date>

Initial ETD date

date_etd_upd
string <date>

Updated ETD date

date_etd_reelle
string <date>

Real ETD date

date_eta_init
string <date>

Initial ETA date

date_eta_upd
string <date>

Updated ETA date

date_eta_reelle
string <date>

Real ETA date

date_rdv_init
string <date>

Initial RDV date

date_rdv_upd
string <date>

Updated RDV date

date_rdv_reelle
string <date>

Real RDV date

status
string (Order Status)

Order status. Example : OPEN, DELETED, RECEIVED

pays_fournisseur
string (Vendor country code) ^[A-Z]{2}$

Example : FR, ES, US, BE

pays_commande
string (Departure country code) ^[A-Z]{2}$

Example : FR, ES, US, BE

fournisseur
string

Vendor name

mode_transport
string (Shipping mode)

Shipping mode. Example : AIR, SEA, ROAD, TRAIN

ref_container
string

Container reference

ref_navire
string

Vessel name

lieu_depart
string

Departure place

lieu_arrivee
string

Arrival place

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Customers

File customer_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Customers lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Customer id

dob
string <date>

Date of Birth

country
string (Country code) ^[A-Z]{2}$

Example : FR, ES, US, BE

gender
string

Gender

optin_email
boolean

Optin Email

optin_sms
boolean

Optin. SMS

store_id
string

Affected Store id

segment
string

Customer Segment

recruited_on
string <date>

Recruitment Date

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Store's Goals

File budget_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key created_on, store_id, objectif_type

Authorizations:
gcpAuth
Request Body schema: application/json
required

Budget lines to Create/Update

Array
created_on
required
string <date>

KEY : Goal Date

objectif_type
required
string
Enum: "COMMERCIAL" "FINANCIAL"

KEY : Goal Type

store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id or website id

objectif_ca
required
number

Turnover Goal incl. taxes in store country currency

objectif_ca_eur
number

Turnover Goal incl. taxes in Company currency

objectif_ma
number

Gross margin goal in store country currency

objectif_ma_eur
number

Gross margin goal in Company currency

lfl_exclude
boolean

Exclude this store from Like For Like on this date

working_hours
number

The working hours of the employees

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Live Transactions

Sales

File sales_YYYYMMDDHHmmss.csv.gz

Frequency hourly

Mode delta

Update Key created_on, id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Sales lines to Create/Update

Array
id
required
string

KEY : Transaction id

created_on
required
string <date>

KEY : Transaction local Date

( In case of web return, the initial transaction date )

line_id
required
string

KEY : Line id in transaction

created_at
required
string^\d{2}:\d{2}:\d{2}$

Transaction local time

created_at_utc
string <date-time>

Transaction Date and Time is UTC Time YYYY-MM-DDTHH:mm:SSZ

store_id
required
string

Store id

product_variant_id
required
string

Product Variant Id

quantity
required
integer

Quantity

currency
required
string

Currency (local currency)

transaction_type
required
string (Transaction Type)
Enum: "V" "R" "C"

Transaction Type : V (sales), R (return), C (gift cards)

price
required
number

Sales price incl. taxes for this line

valpr
required
number or null

Cost price for this line

marge
required
number or null

Gross margin for this line

markdown
required
number or null

Markdown amount incl. taxes for this line

promo
required
number or null

Promotion amount incl. taxes for this line

loyalty
number or null

Loyalty amount incl. taxes for this line

price_eur
required
number

Sales price incl. taxes for this line in Company currency

valpr_eur
required
number or null

Cost price for this line in Company currency

marge_eur
required
number or null

Gross margin for this line in Company currency

markdown_eur
required
number or null

Markdown amount incl. taxes for this line in Company currency

promo_eur
required
number or null

Promotion amount incl. taxes for this line in Company currency

loyalty_eur
number or null

Loyalty amount incl. taxes for this line in Company currency

promo_label
string or null

Promotion label

loyalty_label
string or null

Loyalty Label

customer_id
string or null

Customer id

eticket
boolean or null

Is electronic Bill

season_id
string or null

Season Id / Collection

seasonality
string or null

Seasonality

canal_id
string or null

Sales Channel

shipping_country
string or null^[A-Z]{2}$

Shipping country

shipping_post_code
string or null

Shipping Zip code

shipping_city
string or null

Shipping City

shipping_mode
string or null

Shipping mode for customer

shipping_store_id
string or null

Shipping store id for instore shipping mode

preparing_mode
string or null

Preparation mode

preparing_store_id
string or null

Preparation store id for instore preparing mode

omnichannel_store_id
string or null

Omnichannel Store id assignement

omnichannel_allocation
number or null [ 0 .. 100 ]

Omnichannel Store revenu allocation in percent

order_status
string or null

order status

order_substatus
string or null

order sub status (for cancellations)

shipped_on
string or null <date>

date of shipment (Billing Date)

shipped_at
string^\d{2}:\d{2}:\d{2}$

Local time of shipment (Billing Time)

withdrawn_on
string or null <date>

date of withdraw

return_reason
string or null

Return Main Reason

return_subreason
string or null

Return Sub Reason

origin_store_id
string or null

Store id which initiate the transaction

plan_cluster
string or null

Cluster (Planned)

real_cluster
string or null

Cluster (Real)

price_type
string or null
Enum: "regular" "clearance" "promo"

Price Type

seller_id
string or null

Seller

cashier_id
string or null

Cashier

preparer_id
string or null

Preparer

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Traffic

File traffic_YYYYMMDDHHmmss.csv.gz

Frequency hourly

Mode delta

Update Key created_on, store_id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Store traffic lines to Create/Update

Array
created_on
required
string <date>

KEY : Local Store Date

store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id

hour
required
integer

KEY : Hour. Example : 15 for visitors between 15h00 and 15h59

visitors
required
integer or null

Visitors count

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Optional Masterdata

Badge Levels

File badge_level_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key created_on, store_id, objectif_groupe, objectif_type

Authorizations:
gcpAuth
Request Body schema: application/json
required

Budget Goal lines to Create/Update

Array
store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id

objectif_groupe
required
string
Enum: "customer" "product" "ticket"

KEY : Objectif Group

objectif_type
required
string[a-zA-Z0-9_\-\s]+$

KEY : Objectif Type

created_on
required
string <date>

KEY : Start Validity Date

end_on
required
string <date>

End Validity Date

objectif_value
required
number

Goal Value

objectif_base
required
number

Goal Base

objectif_value_eur
number

Goal Value in Company Currency

objectif_base_eur
number

Goal Base in Company Currency

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Store's Contributions

File contrib_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key fiscal_year, store_id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Stores P&L lines to Create/Update

Array
fiscal_year
required
integer = 4 characters

KEY : Fiscal year

periode_name
string[a-zA-Z0-9_\-\s]+$

KEY : Period name to be displayed in the application

store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store id

ca_ttc
number

Turn Over incl. taxes

ca_ht
number

Gross turn over

marge_commerciale
number

Gross margin

marge_nette
number

Net margin

ca_autres
number

Other revenu

chg_personnel
number

HR costs

chg_loyers
number

Real estate costs

chg_affilie
number

Affiliate commission

chg_transport
number

Logistic costs

chg_publicite
number

Advertising costs

chg_autres
number

Other costs

contribution
required
number

Store EBITDA

currency
required
string

Currency

post_fonctionnemnt
number

Post EBITDA costs

post_contribution
number

Post EBITDA

post_lost
number

Post Shrinkage

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Product Collections

File product_collection_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key product_id, season_id, bmode

Authorizations:
gcpAuth
Request Body schema: application/json
required

Product collection lines to Create/Update

Array
product_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product id

bmode
required
string[a-zA-Z0-9_\-\s]+$

KEY : Business mode

season_id
required
string

KEY : Season Id / Collection

collection
required
string

Collection

sub_collection
string

Sub Collection

seasonality
string

Seasonality

initial_price_eur
number

Inital Price in company currency

c_attr_01
string

Custom Collection Attribut 01

c_attr_02
string

Custom Collection Attribut 02

c_attr_03
string

Custom Collection Attribut 03

c_attr_04
string

Custom Collection Attribut 04

c_attr_05
string

Custom Collection Attribut 05

c_attr_06
string

Custom Collection Attribut 06

c_attr_07
string

Custom Collection Attribut 07

c_attr_08
string

Custom Collection Attribut 08

c_attr_09
string

Custom Collection Attribut 09

c_attr_10
string

Custom Collection Attribut 10

c_attr_11
string

Custom Collection Attribut 11

c_attr_12
string

Custom Collection Attribut 12

c_attr_13
string

Custom Collection Attribut 13

c_attr_14
string

Custom Collection Attribut 14

c_attr_15
string

Custom Collection Attribut 15

c_attr_16
string

Custom Collection Attribut 16

c_attr_17
string

Custom Collection Attribut 17

c_attr_18
string

Custom Collection Attribut 18

c_attr_19
string

Custom Collection Attribut 19

c_attr_20
string

Custom Collection Attribut 20

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Employees

File employee_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Employee lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Employee id

firstname
required
string[a-zA-Z0-9_\-\s]+$

First Name

lastname
required
string

Lastname

store_id
string[a-zA-Z0-9_\-\s]+$

Store id

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Optional Daily Transactions

Badge Realisations

File badge_real_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key created_on, store_id, objectif_groupe, objectif_type

Authorizations:
gcpAuth
Request Body schema: application/json
required

Badge Realisations lines to Create/Update

Array
store_id
required
string

KEY : Store id

objectif_groupe
required
string
Enum: "customer" "product" "ticket"

KEY : Objectif Group

objectif_type
required
string[a-zA-Z0-9_\-\s]+$

KEY : Objectif Type

created_on
required
string <date>

KEY : Date

real_value
required
number

Real Value

real_base
required
number

Real Base

real_value_eur
number

Real Value in company currency

real_base_eur
number

Real Base in company currency

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Shipments

File shipment_YYYYMMDDHHmmss.csv.gz

Frequency daily

Mode delta

Update Key id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Shipment lines to Create/Update

Array
id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Shipment id

store_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Store Id

product_variant_id
required
string[a-zA-Z0-9_\-\s]+$

KEY : Product variant id

shipped_on
required
string <date>

Shipping Date

received_on
required
string <date>

Receiving Date

qty_ship
required
integer

Shipped Quantity

qty_receipt
required
integer

Receipted Quantity

status
string

Status of the shipment

valpr_eur
string or null

Cost price for this line in Company Currency

price_eur
string

Sales price to the partner for this line in Company Currency

season_id
string or null

Season Id / Collection

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}

Optional Live Transactions

Discounts

File discounts_YYYYMMDDHHmmss.csv.gz

Frequency hourly

Mode delta

Update Key created_on, sales_id

Authorizations:
gcpAuth
Request Body schema: application/json
required

Transactions Discounts lines to Create/Update

Array
sales_id
required
string

KEY : Transaction id

created_on
required
string <date>

KEY : Transaction local Date

line_id
required
string

KEY : Line id in transaction

discount_id
required
string

KEY : Discount ID

product_variant_id
required
string

KEY : Product Variant Id

type
string (Discount Type)
Enum: "markdown" "promotion" "loyalty"

Discount Type

label
string (Discount Label)

Discount Type

amount
required
number

Discount amount in local currency price incl. taxes for this line

amount_eur
required
number

Discount amount in company currency price incl. taxes for this line

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "entity_group": "string",
  • "entity_type": "string",
  • "job_id": "string",
  • "line_count": 0
}