Mirakl Marketplace APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Validate the shipment of an order

Request

Validate the shipment of an order in the SHIPPING status

Path
order_idstringrequired

Order's identifier

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/ship?shop_id=0'

Responses

No Content

Perform refunds on order lines

Request

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
order_tax_modestring

Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
Possible values:

  • TAX_EXCLUDED: the price fields (price, unit price, shipping price and order total prices) do not include taxes.
  • TAX_INCLUDED: the price fields include the tax amounts.
  • If not specified, the default order tax mode of the platform is used.

refundsArray of objects(OR28_Request_Refunds)

List of representations of refunds to be created

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/refund?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_tax_mode": "string",
    "refunds": [
      {
        "amount": 0,
        "currency_iso_code": "string",
        "excluded_from_shipment": true,
        "fees": [
          {
            "amount": 0,
            "code": "string"
          }
        ],
        "order_line_id": "string",
        "quantity": 0,
        "reason_code": "string",
        "shipping_amount": 0,
        "shipping_taxes": [
          {
            "amount": 0,
            "code": "string"
          }
        ],
        "taxes": [
          {
            "amount": 0,
            "code": "string"
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
order_tax_modestring

Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the refund.
Possible values:

  • TAX_EXCLUDED: the price fields (amount, shipping amount) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).
  • TAX_INCLUDED: the price fields include the tax amount.

refundsArray of objects(OR28_Response_200_Refunds)

List of representations of created refunds

Response
application/json
{ "order_tax_mode": "string", "refunds": [ { … } ] }

Perform a full cancelation of an order

Request

Path
order_idstringrequired

Order's identifier

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/cancel?shop_id=0'

Responses

No Content

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations