Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Objects
/
Shipment

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

IbanOrderPaymentDestination

Represents a payment destination for an IBAN

iban
String!,non-null

Bank account IBAN

paymentReference
String

The payment reference for bank transfer

Sample
{
  "iban": "Example String",
  "paymentReference": "Example String"
}
Referenced in
OrderPaymentDestination

OrderReference

orderReferenceForCustomer
String

Order reference for customer

Sample
{
  "orderReferenceForCustomer": "Example String"
}
Referenced in
OrderUpdated.references
Order.references

PriceAmount

Represents a price and the breakdown of this price

value
Float!,non-null

Amount

breakdown
AmountBreakdown

The breakdown of the amount

Sample
{
  "value": 40,
  "breakdown": {
    "__typename": "AmountBreakdown"
  }
}
Referenced in
CancelledPriceAmountAndTaxes.amount
CancelledTaxes.amount
OrderLine.price
Cancelation.amount
Refund.amount
ShippingAmountAndTaxes.amount

Refund

Represents a refund made for an order line.

amount
PriceAmount

Refund's amount

createdDate
DateTime

Refund's creation date

ecoContributions
[EcoContribution!]!,non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection.

id
ID!,non-null

Refund's id

quantity
Float

The quantity of products canceled (This quantity is informative only)

reasonCode
String

Reason's code of the refund

shippingAmount
ShippingAmountAndTaxes

Refund's shipping amount and shipping taxes

state
String!,non-null

Refund's state

taxes
[OrderTaxAmount!]!,non-null

The taxes on the price

Sample
{
  "amount": {
    "__typename": "PriceAmount"
  },
  "createdDate": "Example Custom Scalar",
  "ecoContributions": [
    {
      "__typename": "EcoContribution"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "quantity": 40,
  "reasonCode": "Example String",
  "shippingAmount": {
    "__typename": "ShippingAmountAndTaxes"
  },
  "state": "Example String",
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ]
}
Referenced in
OrderLine.refunds

ShippingAmountAndTaxes

Represents a shipping amount and the taxes on this shipping amount

amount
PriceAmount

Shipping amount

taxes
[OrderTaxAmount!]!,non-null

The taxes on the shipping price

Sample
{
  "amount": {
    "__typename": "PriceAmount"
  },
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ]
}
Referenced in
CancelledOrderLine.shippingAmount
OrderLine.shippingPrice
Cancelation.shippingAmount
Refund.shippingAmount

Shipment

Represents a shipment of an order items

createdDate
DateTime!,non-null

Shipment's creation date

id
ID!,non-null

Shipment id

invoiceReference
String

Shipment's invoice reference

paymentDetails
ShipmentPaymentDetails

Shipment's payment details

shipmentLines
[ShipmentLine!]!,non-null

Shipment lines

shippedDate
DateTime

Shipment's shipped date.

status
String!,non-null

Shipment status. Possible values are: SHIPPING, READY_FOR_PICK_UP, SHIPMENT_PREPARED, SHIPPED, TO_COLLECT, RECEIVED, CANCELED, CLOSED.

statusCustomerDebit
String!,non-null

Shipment debit status. Possible values are: NO_DEBIT, NOT_STARTED, WAITING_TAX_CONFIRMATION, WAITING_OPERATOR_SYSTEM_CONTACT, WAITING_DEBIT_CONFIRMATION, DEBIT_OK, CANCELED

tracking
ShipmentTracking

Shipment tracking details

Sample
{
  "createdDate": "Example Custom Scalar",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "invoiceReference": "Example String",
  "paymentDetails": {
    "__typename": "ShipmentPaymentDetails"
  },
  "shipmentLines": [
    {
      "__typename": "ShipmentLine"
    }
  ],
  "shippedDate": "Example Custom Scalar",
  "status": "Example String",
  "statusCustomerDebit": "Example String",
  "tracking": {
    "__typename": "ShipmentTracking"
  }
}
Referenced in
Order.shipments

ShipmentPaymentDetails

Represents a shipment's payment information

customerDebitedDate
DateTime!,non-null

Payment's date of the shipment by the customer

Sample
{
  "customerDebitedDate": "Example Custom Scalar"
}
Referenced in
Shipment.paymentDetails

ShipmentLine

Represents a shipment line

offerSku
String

Offer sku

orderLine
OrderLine

Order line linked to the shipment line

packageReference
String

Package reference

quantity
Int!,non-null

Quantity

Sample
{
  "offerSku": "Example String",
  "orderLine": {
    "__typename": "OrderLine"
  },
  "packageReference": "Example String",
  "quantity": 40
}
Referenced in
Shipment.shipmentLines

ShipmentTracking

Represents a shipment tracking information

carrierCode
String

The code of a carrier. This information is mandatory for a registered carrier.

carrierName
String

The name of a carrier. This information is mandatory for an unregistered carrier.

trackingNumber
String

The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number.

trackingUrl
Url

The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.

Sample
{
  "carrierCode": "Example String",
  "carrierName": "Example String",
  "trackingNumber": "Example String",
  "trackingUrl": "Example Custom Scalar"
}
Referenced in
Shipment.tracking

OrderDocuments

Represents all the documents available on an order

downloadUrl
Url!,non-null

Url to retrieve all order's documents

files
[OrderDocument!]!,non-null

List of all order's documents

Sample
{
  "downloadUrl": "Example Custom Scalar",
  "files": [
    {
      "__typename": "OrderDocument"
    }
  ]
}
Referenced in
Order.documents

OrderDocument

Represents an order's document

dateUploaded
DateTime

Document uploaded date

downloadUrl
Url!,non-null

Url to retrieve this particular document

fileName
String!,non-null

Document file name

fileSize
Int

Document file size

id
ID!,non-null

Document identifier

type
String!,non-null

Document type code

Sample
{
  "dateUploaded": "Example Custom Scalar",
  "downloadUrl": "Example Custom Scalar",
  "fileName": "Example String",
  "fileSize": 40,
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "Example String"
}
Referenced in
OrderDocuments.files

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview