Maremagnum API Documentation
Welcome to the GraphQL Introduction Documentation for our Maremagnum. GraphQL is a query language for APIs that allows for more efficient and flexible communication between the client and the server. It provides a way for clients to request only the data that they need and reduces the amount of over or under-fetching of data. This documentation is intended for developers who want to understand how to interact with the Maremagnum API using GraphQL. We will cover the basics of GraphQL, including the query syntax, mutations, and subscriptions. We will also provide examples of how to make queries and mutations to retrieve and update data in the Maremagnum. Additionally, we will cover the different types of data that are available, including books, authors, and reviews. Whether you're a seasoned GraphQL developer or just getting started, this documentation will help you get up and running with our Maremagnum API. Let's get started!
API Endpoints
https://api.maremagnum.com/graphqlHeaders
# Your API token from the dashboard. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>Version
0.58-3
Where i can find my API token?
How to Get Your API-Token in Your Administrative Dashboard
In order to access to Maremagnum API, you need to have an API-Token. If you do not have one, you can easily generate it by following these steps:
- Login to your administrative dashboard
- Navigate to the section "Service Account"
- If you do not already have an API-Token, you will see a button labeled "Generate".
- Push the "Generate" button to generate your API-Token
- Your API-Token will now be displayed in the "Service Account" section
It is important to keep your API-Token secure and not to share it with anyone else. You can regenerate it at any time if you suspect it has been compromised.
Queries
ncd
Description
Lista delle note di conto deposito.
Response
Returns [Ncd!]!
Arguments
| Name | Description |
|---|---|
first - Int
|
Return at most N records. Something like SQL LIMIT clause. Default is 100. Max value is 100. |
where - NcdWhereClauseInput
|
A JSON object conforming the the shape specified in the NcdWhereClauseInput type. This allows for filtering orders by any of the fields in the order object. |
Example
Query
query ncd(
$first: Int,
$where: NcdWhereClauseInput
) {
ncd(
first: $first,
where: $where
) {
tsCreated
tsUpdated
tsPrinted
progressivo
data
codiceFiscale
partitaIva
codiceDestinatarioSdi
cognome
nome
ragioneSociale
indirizzo
citta
provinciaStato
cap
nazione
totale
righe {
...RigaNcdFragment
}
}
}
Variables
{"first": 42, "where": NcdWhereClauseInput}
Response
{
"data": {
"ncd": [
{
"tsCreated": "2023-11-29T13:32:36.690Z",
"tsUpdated": "2023-11-29T13:32:36.690Z",
"tsPrinted": "2007-12-03",
"progressivo": "xyz789",
"data": "2007-12-03",
"codiceFiscale": "xyz789",
"partitaIva": "abc123",
"codiceDestinatarioSdi": "abc123",
"cognome": "xyz789",
"nome": "xyz789",
"ragioneSociale": "xyz789",
"indirizzo": "xyz789",
"citta": "xyz789",
"provinciaStato": "xyz789",
"cap": "abc123",
"nazione": "xyz789",
"totale": Decimal,
"righe": [RigaNcd]
}
]
}
}
orders
Description
Get a list of orders filtered and sorted by the given parameters.
Response
Returns [Order!]!
Arguments
| Name | Description |
|---|---|
first - Int
|
Return at most N records. Something like SQL LIMIT clause. Default is 250. Max value is 250. |
orderBy - OrderBy
|
Sort Ascending or Descending. Default is DESC. |
where - OrderWhereClauseInput
|
A JSON object conforming the the shape specified in the OrderWhereClauseInput type. This allows for filtering orders by any of the fields in the order object. |
Example
Query
query orders(
$first: Int,
$orderBy: OrderBy,
$where: OrderWhereClauseInput
) {
orders(
first: $first,
orderBy: $orderBy,
where: $where
) {
tsCreated
ts
number
total
totalShippingCost
totalDiscount
orderDate
status
paymentStatus
shippingAddress {
...ShippingAddressFragment
}
billingAddress {
...BillingAddressFragment
}
orderLines {
...OrderLineFragment
}
shipments {
...ShipmentFragment
}
coupons {
...DiscountCouponFragment
}
}
}
Variables
{
"first": 42,
"orderBy": "Asc",
"where": OrderWhereClauseInput
}
Response
{
"data": {
"orders": [
{
"tsCreated": "2023-11-29T13:32:36.690Z",
"ts": "2023-11-29T13:32:36.690Z",
"number": "xyz789",
"total": Decimal,
"totalShippingCost": Decimal,
"totalDiscount": Decimal,
"orderDate": "2007-12-03",
"status": "WAITING_AVAILABILITY",
"paymentStatus": "PROCESSING",
"shippingAddress": ShippingAddress,
"billingAddress": BillingAddress,
"orderLines": [OrderLine],
"shipments": [Shipment],
"coupons": [DiscountCoupon]
}
]
}
}
product
Description
Get a product by id.
Example
Query
query product($id: IdInput!) {
product(id: $id) {
id
ts
visible
title
slug
description
stock
allocated
price
productClass
codiceIva
discount
weight
details {
...ProductDetailFragment
}
}
}
Variables
{"id": IdInput}
Response
{
"data": {
"product": {
"id": "4",
"ts": "2023-11-29T13:32:36.690Z",
"visible": true,
"title": "4",
"slug": "abc123",
"description": "xyz789",
"stock": 42,
"allocated": 42,
"price": Decimal,
"productClass": "Book",
"codiceIva": "Art36",
"discount": 42,
"weight": 42,
"details": [ProductDetail]
}
}
}
products
Description
Get all the products.
Response
Returns [Product!]!
Example
Query
query products(
$offset: Int,
$limit: Int
) {
products(
offset: $offset,
limit: $limit
) {
id
ts
visible
title
slug
description
stock
allocated
price
productClass
codiceIva
discount
weight
details {
...ProductDetailFragment
}
}
}
Variables
{"offset": 42, "limit": 42}
Response
{
"data": {
"products": [
{
"id": 4,
"ts": "2023-11-29T13:32:36.690Z",
"visible": false,
"title": 4,
"slug": "abc123",
"description": "xyz789",
"stock": 42,
"allocated": 42,
"price": Decimal,
"productClass": "Book",
"codiceIva": "Art36",
"discount": 42,
"weight": 42,
"details": [ProductDetail]
}
]
}
}
productsCount
Description
Get the number of products present in Mare Manum database.
Response
Returns an Int!
Example
Query
query productsCount {
productsCount
}
Response
{"data": {"productsCount": 42}}
Mutations
confirmAvailability
Description
Confirm availability of a order.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
orderNumber - IdInput!
|
Unique ID for the order that will be confirmed. |
Example
Query
mutation confirmAvailability($orderNumber: IdInput!) {
confirmAvailability(orderNumber: $orderNumber)
}
Variables
{"orderNumber": IdInput}
Response
{"data": {"confirmAvailability": false}}
productDelete
Description
Delete an existing product from the Mare Magnum database.
productMassiveDelete
Description
Massively delete products from the Mare Magnum database.
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
ids - [IdInput!]!
|
List of IDs for products that will be deleted. Max 500 items per request. |
Example
Query
mutation productMassiveDelete($ids: [IdInput!]!) {
productMassiveDelete(ids: $ids)
}
Variables
{"ids": [IdInput]}
Response
{"data": {"productMassiveDelete": 42}}
productUpdateCreate
Description
Create a new product or update an existing one.
Response
Returns a Product!
Arguments
| Name | Description |
|---|---|
input - ProductInput!
|
The product that will be created or updated by this mutation |
Example
Query
mutation productUpdateCreate($input: ProductInput!) {
productUpdateCreate(input: $input) {
id
ts
visible
title
slug
description
stock
allocated
price
productClass
codiceIva
discount
weight
details {
...ProductDetailFragment
}
}
}
Variables
{"input": ProductInput}
Response
{
"data": {
"productUpdateCreate": {
"id": "4",
"ts": "2023-11-29T13:32:36.690Z",
"visible": false,
"title": "4",
"slug": "xyz789",
"description": "abc123",
"stock": 42,
"allocated": 42,
"price": Decimal,
"productClass": "Book",
"codiceIva": "Art36",
"discount": 42,
"weight": 42,
"details": [ProductDetail]
}
}
}
updateAuthToken
Description
Update the authentication token.
Response
Returns an AuthToken!
Example
Query
mutation updateAuthToken {
updateAuthToken {
token
expires
}
}
Response
{
"data": {
"updateAuthToken": {
"token": "abc123",
"expires": "2023-11-29T13:32:36.690Z"
}
}
}
updateShippingData
Description
Update shipping related data. All fields are optional, but you must provide at least the order number.
Response
Returns a Boolean!
Example
Query
mutation updateShippingData(
$notes: String,
$trackingURL: String,
$expectedDeliveryDate: DateInput,
$pickupDate: DateInput,
$orderNumber: IdInput!
) {
updateShippingData(
notes: $notes,
trackingURL: $trackingURL,
expectedDeliveryDate: $expectedDeliveryDate,
pickupDate: $pickupDate,
orderNumber: $orderNumber
)
}
Variables
{
"notes": "xyz789",
"trackingURL": "xyz789",
"expectedDeliveryDate": DateInput,
"pickupDate": DateInput,
"orderNumber": IdInput
}
Response
{"data": {"updateShippingData": false}}
voidSingleOrderLine
Description
Void a single order line.
Response
Returns a Boolean!
Example
Query
mutation voidSingleOrderLine(
$productID: IdInput!,
$orderNumber: IdInput!
) {
voidSingleOrderLine(
productID: $productID,
orderNumber: $orderNumber
)
}
Variables
{
"productID": IdInput,
"orderNumber": IdInput
}
Response
{"data": {"voidSingleOrderLine": false}}
Types
AuthToken
Fields
| Field Name | Description |
|---|---|
token - String!
|
The authentication token. |
expires - Timestamp!
|
The expiration date of the authentication token. |
Example
{
"token": "xyz789",
"expires": "2023-11-29T13:32:36.690Z"
}
BillingAddress
Fields
| Field Name | Description |
|---|---|
fiscalProfile - FiscalProfile!
|
Type of fiscal entity |
fiscalCode - String
|
Fiscal code. |
vatNumber - String
|
VAT Number. |
italianSdiCode - String
|
Italian SDI code. |
lastName - String
|
Last name. |
firstName - String
|
First name. |
birthday - Date
|
Birthday. |
companyName - String
|
Company name. |
address - String
|
Address. |
city - String
|
City. |
state - String
|
Province/state. |
zipCode - String
|
ZIP code. |
nation - String
|
Natio. Two letters following ISO 3166-1 alpha-2, e.g. IT. |
Example
{
"fiscalProfile": "NONE",
"fiscalCode": "xyz789",
"vatNumber": "abc123",
"italianSdiCode": "xyz789",
"lastName": "xyz789",
"firstName": "abc123",
"birthday": "2007-12-03",
"companyName": "abc123",
"address": "abc123",
"city": "abc123",
"state": "abc123",
"zipCode": "xyz789",
"nation": "abc123"
}
Boolean
Example
true
Date
Description
A date, formatted according to RFC3339. Example: 2023-02-02
Example
"2007-12-03"
DateInput
Description
A date, formatted according to RFC3339. Example: 2023-02-02
Example
DateInput
Decimal
Description
Arbitrary-precision floating-point decimal type.
Example
Decimal
DecimalInput
Description
Arbitrary-precision floating-point decimal type.
Example
DecimalInput
DetailName
Description
Name of a product detail.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book_Author"
DetailNameInput
Description
Name of a product detail.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book_Author"
DetailType
Description
Type of a product detail.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Text"
DetailTypeInput
Description
Type of a product detail.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Text"
DiscountCoupon
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique code identifying this discount coupon. |
validFrom - Date!
|
The date when this discount coupon becomes valid. |
validTo - Date!
|
The date when this discount coupon expires. |
maxUses - Int!
|
The maximum number of times this discount coupon can be used. |
value - Decimal!
|
The value of this discount coupon, in EUR. |
Example
{
"id": "4",
"validFrom": "2007-12-03",
"validTo": "2007-12-03",
"maxUses": 42,
"value": Decimal
}
FiscalProfile
Description
The fiscal profile of a customer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as the key for a cache. The ID type is serialized in the same way as a String; however, defining it as an ID signifies that it is not intended to be human‐readable.
Example
4
IdInput
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as the key for a cache. The ID type is serialized in the same way as a String; however, defining it as an ID signifies that it is not intended to be human‐readable.
Example
IdInput
Int
Example
42
Ncd
Fields
| Field Name | Description |
|---|---|
tsCreated - Timestamp!
|
Timestamp di creazione di questa nota di conto deposito. |
tsUpdated - Timestamp!
|
Timestamp di ultima modifica di questa nota di conto deposito. |
tsPrinted - Date
|
Timestamp di stampa di questa nota di conto deposito. |
progressivo - String!
|
Progressivo di questa nota di conto deposito. |
data - Date!
|
Data di questa nota di conto deposito. |
codiceFiscale - String
|
Codice fiscale dell'intestatario di questa nota di conto deposito. |
partitaIva - String
|
Partita IVA dell'intestatario di questa nota di conto deposito. |
codiceDestinatarioSdi - String
|
Codice destinatario SDI dell'intestatario di questa nota di conto deposito. |
cognome - String
|
Cognome dell'intestatario di questa nota di conto deposito. |
nome - String
|
Nome dell'intestatario di questa nota di conto deposito. |
ragioneSociale - String
|
Ragione sociale dell'intestatario di questa nota di conto deposito. |
indirizzo - String
|
Indirizzo dell'intestatario di questa nota di conto deposito. |
citta - String
|
Città dell'intestatario di questa nota di conto deposito. |
provinciaStato - String
|
Provincia o stato dell'intestatario di questa nota di conto deposito. |
cap - String
|
CAP dell'intestatario di questa nota di conto deposito. |
nazione - String
|
Nazione dell'intestatario di questa nota di conto deposito. |
totale - Decimal!
|
Totale di questa nota di conto deposito. |
righe - [RigaNcd!]!
|
Righe di questa nota di conto deposito. |
Example
{
"tsCreated": "2023-11-29T13:32:36.690Z",
"tsUpdated": "2023-11-29T13:32:36.690Z",
"tsPrinted": "2007-12-03",
"progressivo": "xyz789",
"data": "2007-12-03",
"codiceFiscale": "abc123",
"partitaIva": "abc123",
"codiceDestinatarioSdi": "abc123",
"cognome": "xyz789",
"nome": "xyz789",
"ragioneSociale": "abc123",
"indirizzo": "xyz789",
"citta": "abc123",
"provinciaStato": "abc123",
"cap": "xyz789",
"nazione": "xyz789",
"totale": Decimal,
"righe": [RigaNcd]
}
NcdWhereClauseInput
OptionValue
Description
The value of a product option when it's a fixed choice.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book_Binding_Hardcover"
OptionValueInput
Description
The value of a product option when it's a fixed choice.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book_Binding_Hardcover"
Order
Fields
| Field Name | Description |
|---|---|
tsCreated - Timestamp!
|
Timestamp of creation of this order. |
ts - Timestamp!
|
Timestamp of last modification of this order. |
number - String!
|
Unique ID of this order. It can be used to get this GraphQL object. |
total - Decimal!
|
Total amount of money payed by the customer, including tax and shipping costs. |
totalShippingCost - Decimal!
|
The sum of all the shipping costs of this order. |
totalDiscount - Decimal!
|
The sum of all the discounts applied to this order. |
orderDate - Date!
|
The date when this order was payed. |
status - Status!
|
Order status. |
paymentStatus - PaymentStatus!
|
Order payment status. |
shippingAddress - ShippingAddress!
|
The address where this order will be shipped. |
billingAddress - BillingAddress!
|
The billing address of this order. |
orderLines - [OrderLine!]!
|
The list of products bought by the customer. |
shipments - [Shipment!]!
|
The list of shipments associated with this order. |
coupons - [DiscountCoupon!]!
|
The list of discount coupons associated with this order. |
Example
{
"tsCreated": "2023-11-29T13:32:36.690Z",
"ts": "2023-11-29T13:32:36.690Z",
"number": "abc123",
"total": Decimal,
"totalShippingCost": Decimal,
"totalDiscount": Decimal,
"orderDate": "2007-12-03",
"status": "WAITING_AVAILABILITY",
"paymentStatus": "PROCESSING",
"shippingAddress": ShippingAddress,
"billingAddress": BillingAddress,
"orderLines": [OrderLine],
"shipments": [Shipment],
"coupons": [DiscountCoupon]
}
OrderBy
Description
Order by clause.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Asc"
OrderLine
Fields
| Field Name | Description |
|---|---|
title - String
|
Title of the product. |
unitPriceTaxIncluded - Decimal!
|
Unit price of the product, including tax. |
qty - Int!
|
Number of items of this product bought by the customer. |
taxes - Decimal!
|
The amount of taxes payed by the customer for this product. |
totalDiscount - Decimal!
|
The amount of discount applied to this product. |
notAvailable - Boolean!
|
True if this product is not available anymore. |
vatCode - RegimeIva!
|
The VAT code of this product. |
privateId - String!
|
The bookshop ID of this product. |
authors - [String!]!
|
The author of this product. |
publishers - [String!]!
|
The publisher of this product. |
year - Int
|
The year of publication of this product. |
Example
{
"title": "xyz789",
"unitPriceTaxIncluded": Decimal,
"qty": 42,
"taxes": Decimal,
"totalDiscount": Decimal,
"notAvailable": true,
"vatCode": "Art36",
"privateId": "xyz789",
"authors": ["xyz789"],
"publishers": ["abc123"],
"year": 42
}
OrderWhereClauseInput
Fields
| Input Field | Description |
|---|---|
statusEqual - StatusInput
|
The order status must be equal to this value. |
paymentStatusIsEqual - PaymentStatusInput
|
The payment status must be equal to this value. |
dateLte - DateInput
|
The order date must be less or equal to this value. |
dateGte - DateInput
|
The order date must be greater or equal to this value. |
numberIsEqual - String
|
The order number must be equal to this value. |
Example
{
"statusEqual": "WAITING_AVAILABILITY",
"paymentStatusIsEqual": "PROCESSING",
"dateLte": DateInput,
"dateGte": DateInput,
"numberIsEqual": "xyz789"
}
PaymentStatus
Description
Payment status.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PROCESSING"
PaymentStatusInput
Description
Payment status.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PROCESSING"
Product
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique ID of this product. It can be used to get this GraphQL object. |
ts - Timestamp!
|
Timestamp of last modification of this product. |
visible - Boolean!
|
True if this product will be visible (actually published). |
title - ID!
|
Title of this product. |
slug - String
|
The "slug" generated by Mare Magnum for this product. |
description - String
|
Description of this product. |
stock - Int!
|
Number of items actually, physically, sellable. |
allocated - Int!
|
The number of items present in Mare Magnum for this product that are allocated in other orders and not sellable. No more meaningful. |
price - Decimal!
|
Product price paid by the customer, including tax. |
productClass - ProductClass!
|
The product category of this product. |
codiceIva - RegimeIva!
|
Tax regime of this product. |
discount - Int!
|
Percentage discount for this product. |
weight - Int!
|
Weight in grams of this product. |
details - [ProductDetail!]!
|
Product details (authors, year of publication, etc...) |
Example
{
"id": 4,
"ts": "2023-11-29T13:32:36.690Z",
"visible": true,
"title": 4,
"slug": "abc123",
"description": "abc123",
"stock": 42,
"allocated": 42,
"price": Decimal,
"productClass": "Book",
"codiceIva": "Art36",
"discount": 42,
"weight": 42,
"details": [ProductDetail]
}
ProductClass
Description
Product categories available inside Mare Magnum.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book"
ProductClassInput
Description
Product categories available inside Mare Magnum.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Book"
ProductDetail
Fields
| Field Name | Description |
|---|---|
detailName - DetailName!
|
The name of the attribute. |
detailType - DetailType!
|
The type of the attribute. |
valueText - String
|
The value of the attribute in case detailType is Text. |
valueInteger - Int
|
The value of the attribute in case detailType is Integer. |
valueDecimal - Decimal
|
The value of the attribute in case detailType is Decimal. |
valueBool - Boolean
|
The value of the attribute in case detailType is Bool. |
valueDate - Date
|
The value of the attribute in case detailType is Date. |
valueDatetime - Timestamp
|
The value of the attribute in case detailType is Datetime. |
valueOption - OptionValue
|
The value of the attribute in case detailType is Option. |
valueArray - [String!]
|
The value of the attribute in case detailType is Array. |
valueOptionArray - [OptionValue!]
|
The value of the attribute in case detailType is OptionArray. |
Example
{
"detailName": "Book_Author",
"detailType": "Text",
"valueText": "abc123",
"valueInteger": 42,
"valueDecimal": Decimal,
"valueBool": true,
"valueDate": "2007-12-03",
"valueDatetime": "2023-11-29T13:32:36.690Z",
"valueOption": "Book_Binding_Hardcover",
"valueArray": ["xyz789"],
"valueOptionArray": ["Book_Binding_Hardcover"]
}
ProductDetailInput
Fields
| Input Field | Description |
|---|---|
valueOptionArray - [OptionValueInput!]
|
The value of the attribute in case detailType is OptionArray. |
valueArray - [String!]
|
The value of the attribute in case detailType is Array. |
valueOption - OptionValueInput
|
The value of the attribute in case detailType is Option. |
valueDatetime - TimestampInput
|
The value of the attribute in case detailType is Datetime. |
valueDate - DateInput
|
The value of the attribute in case detailType is Date. |
valueBool - Boolean
|
The value of the attribute in case detailType is Bool. |
valueDecimal - DecimalInput
|
The value of the attribute in case detailType is Decimal. |
valueInteger - Int
|
The value of the attribute in case detailType is Integer. |
valueText - String
|
The value of the attribute in case detailType is Text. |
detailType - DetailTypeInput!
|
The type of the attribute. |
detailName - DetailNameInput!
|
The name of the attribute. |
Example
{
"valueOptionArray": ["Book_Binding_Hardcover"],
"valueArray": ["xyz789"],
"valueOption": "Book_Binding_Hardcover",
"valueDatetime": TimestampInput,
"valueDate": DateInput,
"valueBool": true,
"valueDecimal": DecimalInput,
"valueInteger": 42,
"valueText": "abc123",
"detailType": "Text",
"detailName": "Book_Author"
}
ProductInput
Fields
| Input Field | Description |
|---|---|
details - [ProductDetailInput!]!
|
Product details (authors, year of publication, etc...) |
images - [String!]
|
List of image URLs associated with this product. |
weight - Int!
|
Weight in grams of this product. |
discount - Int!
|
Percentage discount for this product. |
codiceIva - RegimeIvaInput!
|
Tax regime of this product. |
productClass - ProductClassInput!
|
The product category of this product. |
price - DecimalInput!
|
Product price paid by the customer, including tax. |
stock - Int!
|
Number of items actually, physically, sellable. |
description - String!
|
Description of this product. |
title - String!
|
Title of this product. |
visible - Boolean!
|
True if this product will be visible (actually published). |
id - String!
|
Unique ID of this product in the library catalog. |
Example
{
"details": [ProductDetailInput],
"images": ["abc123"],
"weight": 42,
"discount": 42,
"codiceIva": "Art36",
"productClass": "Book",
"price": DecimalInput,
"stock": 42,
"description": "xyz789",
"title": "xyz789",
"visible": false,
"id": "abc123"
}
RegimeIva
Description
Regime fiscale.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Art36"
RegimeIvaInput
Description
Regime fiscale.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Art36"
RigaNcd
Fields
| Field Name | Description |
|---|---|
numeroOrdine - String!
|
Numero dell'ordine a cui appartiene questa riga di nota di conto deposito. |
descrizione - String!
|
Descrizione della riga di questa nota di conto deposito. |
importo - Decimal!
|
Importo della riga di questa nota di conto deposito. |
titolo - String
|
Titolo del prodotto della riga di questa nota di conto deposito. |
idProdotto - String
|
ID del prodotto della riga di questa nota di conto deposito. |
Example
{
"numeroOrdine": "abc123",
"descrizione": "abc123",
"importo": Decimal,
"titolo": "xyz789",
"idProdotto": "xyz789"
}
Shipment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique ID of this shipment. It can be used to get this GraphQL object. |
tsCreated - Timestamp!
|
Timestamp of creation of this shipment. |
ts - Timestamp!
|
Timestamp of last modification of this shipment. |
pickupDate - Date
|
The date when the shipment was picked up by the courier. |
scheduledDeliveryDate - Date
|
The date when the shipment is scheduled to be delivered to the customer. |
trackingUrl - String
|
The URL where the customer can track the shipment. |
wayBill - String
|
The URL of the waybill document in PDF format. |
shippingType - ShippingType!
|
The type of shipping used for this shipment. |
cost - Decimal!
|
The cost the customer payed for this shipment. |
weight - Decimal!
|
The weight in grams of this shipment. |
Example
{
"id": 4,
"tsCreated": "2023-11-29T13:32:36.690Z",
"ts": "2023-11-29T13:32:36.690Z",
"pickupDate": "2007-12-03",
"scheduledDeliveryDate": "2007-12-03",
"trackingUrl": "abc123",
"wayBill": "xyz789",
"shippingType": "Shop_pickup",
"cost": Decimal,
"weight": Decimal
}
ShippingAddress
Fields
| Field Name | Description |
|---|---|
name - String
|
Name of the customer. |
careOf - String
|
Care of |
phoneNumber - String
|
Phone number. |
fax - String
|
FAX number. |
email - String
|
Email address. |
addressLine1 - String
|
Address: first line. |
addressLine2 - String
|
Address: secondf line. |
city - String
|
City. |
state - String
|
Province/state. |
zipCode - String
|
ZIP code. |
nation - String
|
Natio. Two letters following ISO 3166-1 alpha-2, e.g. IT. |
notes - String
|
Notes about the shipping address. |
Example
{
"name": "xyz789",
"careOf": "xyz789",
"phoneNumber": "xyz789",
"fax": "xyz789",
"email": "abc123",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "xyz789",
"nation": "abc123",
"notes": "xyz789"
}
ShippingType
Description
Shipping types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Shop_pickup"
Status
Description
Order status.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WAITING_AVAILABILITY"
StatusInput
Description
Order status.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WAITING_AVAILABILITY"
String
Example
"xyz789"
Timestamp
Description
A timestamp with time zone and microsecond precision. Example: 2023-02-02T13:35:07.861Z
Example
2023-11-29T13:32:36.690Z
TimestampInput
Description
A timestamp with time zone and microsecond precision. Example: 2023-02-02T13:35:07.861Z
Example
TimestampInput