ManoMano Partners API

https://www.manomano.dev
Admin
ManoMano Partners API is a REST-based API ecosystem that enables partners to programmatically access...
Tokens:6,840
Snippets:70
Trust Score:5.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Product Attribute Response

Source: https://www.manomano.dev/

This is an example of the JSON response when requesting product attributes. It includes details for both dynamic and static attributes.

```json
{
  "content": [
    {
      "id": "1",
      "name": "Length",
      "names": {
        "en_GB": "Length"
      },
      "descriptions": {
        "en_GB": ""
      },
      "contract_type": "all",
      "datatype": "numerical",
      "type": "product",
      "field_id_for_units_list": "U11",
      "range": [
        0,
        1000
      ],
      "unit_used_for_range": "cm",
      "mandatory": true,
      "variant": false
    },
    {
      "id": "14515",
      "name": "Main material",
      "names": {
        "en_GB": "Main material"
      },
      "descriptions": {
        "en_GB": ""
      },
      "contract_type": "all",
      "datatype": "textual",
      "type": "product",
      "mandatory": true,
      "variant": false,
      "accepted_values": [
        "Clay",
        "Concrete",
        "Bitumen",
        "Wood",
        "Ceramic",
        "Leather",
        "Jeans",
        "Seagrass",
        "Metal",
        "Wicker",
        "Straw",
        "Paper",
        "Stone",
        "Plastic",
        "PVC",
        "Resin",
        "Rattan",
        "Textile",
        "Fabric",
        "Glass",
        "Steel",
        "Copper",
        "Lead",
        "Stainless steel",
        "Cross-linked Polyethylene",
        "Cast iron",
        "Aluminium",
        "Acrylic",
        "Cotton",
        "Canvas",
        "Rubber",
        "EVA",
        "Nubuck",
        "Polyurethane",
        "Velour",
        "Microfibre",
        "Synthetic",
        "Nylon",
        "Wool",
        "Nitrile",
        "Polyester",
        "Polyethylene",
        "Fir",
        "Beech",
        "Oak",
        "Maple",
        "Bamboo",
        "Pine",
        "Walnut",
        "Apple tree",
        "Cherry wood"
      ]
    }
  ]
}
```

--------------------------------

### Example XML for Shipped Product

Source: https://www.manomano.dev/

This XML structure indicates that a product has already been shipped.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
    <code>
        <![CDATA[3]]>
    </code>
    <message>
        <![CDATA[Product already in package]]>
    </message>
    <datas></datas>
</content>
```

--------------------------------

### Example XML for Successful Shipping Creation

Source: https://www.manomano.dev/

This XML response indicates a successful creation of a shipping request.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
    <code>
        <![CDATA[0]]>
    </code>
    <message>
        <![CDATA[Success]]>
    </message>
    <datas></datas>
</content>
```

--------------------------------

### Get Product Attributes by Category ID

Source: https://www.manomano.dev/

Use this endpoint to retrieve a list of attributes relevant to a specific product category. Ensure you provide a valid category_id. The 'type' parameter should be set to 'product'.

```curl
curl --location 'https://partnersapi.manomano.com/api/v2/feeds/fields?type=product&category_id=19614&page=1&limit=50' \
--header 'x-api-key: {{api.apikey.value}}'
```

--------------------------------

### Get attributes information by category id

Source: https://www.manomano.dev/

Retrieve a list of attributes used in the import feed to provide the catalog information in ManoMano. The attributes contain attributes related to a specific category and static attributes necessary to create a new product.

```APIDOC
## GET /api/v2/feeds/fields

### Description
Retrieve a list of attributes used in the import feed to provide the catalog information in ManoMano. The attributes contain the attributes related to a specific category (selected by query param) and the static attributes necessary to create a new product in ManoMano.

### Method
GET

### Endpoint
https://partnersapi.manomano.com/api/v2/feeds/fields

### Parameters
#### Query Parameters
- **type** (string) - Optional - Scope of attributes: product or offers.
- **category_id** (integer) - Required - The category id to retrieve the specific attributes for this category. The category_id is MANDATORY for the product type or without type query param.
- **page** (integer) - Optional - To go directly to specific pagination (offset). Default: 1
- **limit** (integer) - Optional - Number of elements to retrieve per request. Default: 20

### Request Example
```curl
curl --location 'https://partnersapi.manomano.com/api/v2/feeds/fields?type=product&category_id=19614&page=1&limit=50' \
--header 'x-api-key: {{api.apikey.value}}'
```

### Response
#### Success Response (200)
- **content** (array) - A collection of attributes with pagination.
  - **id** (string) - The attribute id. Integer for dynamic attributes, starts with 'S' for static attributes, starts with 'U' for attribute units.
  - **name** (string) - Name of the attribute.
  - **names** (object) - The name of the attribute in different languages.
    - **en_GB** (string) - English name.
  - **descriptions** (object) - The definition of the attribute in different languages.
    - **en_GB** (string) - English description.
  - **contract_type** (string) - If the attribute is used for manomano fulfillment contracts or for standard contracts.
  - **datatype** (string) - The datatype of the attribute (numerical, textual, etc.).
  - **type** (string) - The scope of the attribute in the feed type (products or offers or all).
  - **field_id_for_units_list** (string) - Attribute ID with the available unit values for this attribute.
  - **range** (array) - Range of allowed values, for example from 0 to 100 for percentage values.
  - **unit_used_for_range** (string) - Default unit for this attribute.
  - **mandatory** (boolean) - If the attribute is mandatory for the import or not.
  - **variant** (boolean) - If the attribute is a variant or not.
  - **accepted_values** (array) - Only for attribute unit information. List of allowed units for this attribute.
  - **field_id_with_value_linked** (string) - Only for attribute unit information. Attribute id related to the attribute unit.

#### Response Example
```json
{
  "content": [
    {
      "id": "1",
      "name": "Length",
      "names": {
        "en_GB": "Length"
      },
      "descriptions": {
        "en_GB": ""
      },
      "contract_type": "all",
      "datatype": "numerical",
      "type": "product",
      "field_id_for_units_list": "U11",
      "range": [
        0,
        1000
      ],
      "unit_used_for_range": "cm",
      "mandatory": true,
      "variant": false
    },
    {
      "id": "14515",
      "name": "Main material",
      "names": {
        "en_GB": "Main material"
      },
      "descriptions": {
        "en_GB": ""
      },
      "contract_type": "all",
      "datatype": "textual",
      "type": "product",
      "mandatory": true,
      "variant": false,
      "accepted_values": [
        "Clay",
        "Concrete",
        "Bitumen",
        "Wood",
        "Ceramic",
        "Leather",
        "Jeans",
        "Seagrass",
        "Metal",
        "Wicker",
        "Straw",
        "Paper",
        "Stone",
        "Plastic",
        "PVC",
        "Resin",
        "Rattan",
        "Textile",
        "Fabric",
        "Glass",
        "Steel",
        "Copper",
        "Lead",
        "Stainless steel",
        "Cross-linked Polyethylene",
        "Cast iron",
        "Aluminium",
        "Acrylic",
        "Cotton",
        "Canvas",
        "Rubber",
        "EVA",
        "Nubuck",
        "Polyurethane",
        "Velour",
        "Microfibre",
        "Synthetic",
        "Nylon",
        "Wool",
        "Nitrile",
        "Polyester",
        "Polyethylene",
        "Fir",
        "Beech",
        "Oak",
        "Maple",
        "Bamboo",
        "Pine",
        "Walnut",
        "Apple tree",
        "Cherry wood"
      ]
    }
  ]
}
```

--------------------------------

### cURL Request for Create Shipping

Source: https://www.manomano.dev/

This cURL command demonstrates how to create a shipping request. Ensure all parameters, including login and password, are correctly formatted.

```curl
curl --location 'https://ws.monechelle.com?method=create_shipping&order_ref=M121100000002&tracking_number=C11124124511&tracking_url=http%253A%252F%252Fwww.laposte.fr%252Fsuivicolis%253Fnumero_colis%253DC11124124511&carrier=Collissimo&shipping_date=2021-02-15&estimated_delivery_date=2021-02-17' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

--------------------------------

### cURL Request for Create Refund

Source: https://www.manomano.dev/

This cURL command illustrates how to initiate a refund request for a specific order item. The shipping_price parameter is optional.

```curl
curl --location 'https://ws.monechelle.com?method=create_refund%20&order_ref=M121100000003&sku=C009&quantity=1&shipping_price=9.50' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

--------------------------------

### Create Refund

Source: https://www.manomano.dev/

This method is used to request the refund of a given quantity of a product on an order. It requires order reference, SKU, and quantity. Shipping price can also be provided for a partial refund of shipping fees.

```APIDOC
## POST create_refund

### Description
This create_refund method is used to request the refund of a given quantity of one product on one order. Once the request created, it will be processed by manomano.com

### Method
POST

### Endpoint
https://ws.monechelle.com

### Parameters
#### Query Parameters
- **method** (string) - Required - `create_refund`
- **order_ref** (string) - Required - The MM order reference (A letter M with 12 digits)
- **sku** (string) - Required - Seller SKU on which the refund request applies
- **quantity** (integer) - Required - Quantity of product to refund
- **shipping_price** (float) - Optional - Amount of shipping fees to refund. This amount is added to the product price. This parameter is not mandatory. If it is not provided, only the products will be refunded.

#### Request Body
- **login** (string) - Required - Credentials for authentication
- **password** (string) - Required - Credentials for authentication

### Request Example
```curl
curl --location 'https://ws.monechelle.com?method=create_refund%20&order_ref=M121100000003&sku=C009&quantity=1&shipping_price=9.50' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

### Response
#### Success Response (200)
- **code** (string) - Indicates the status of the operation. `0` for success.
- **message** (string) - A message describing the result of the operation. `Success` for a successful operation.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
    <code>
        <![CDATA[0]]>
    </code>
    <message>
        <![CDATA[Success]]>
    </message>
    <datas></datas>
</content>
```
```

--------------------------------

### Create Shipping

Source: https://www.manomano.dev/

This method is used to create a new shipment for an order. It requires order reference, tracking number, and optionally accepts tracking URL, carrier, shipping date, and estimated delivery date.

```APIDOC
## POST create_shipping

### Description
This method is used to create a new shipment for an order.

### Method
POST

### Endpoint
https://ws.monechelle.com

### Parameters
#### Query Parameters
- **method** (string) - Required - `create_shipping`
- **order_ref** (string) - Required - The MM order reference (A letter M with 12 digits)
- **tracking_number** (string) - Required - Tracking number of the shipment
- **tracking_url** (string) - Optional - Encoded URL link of the parcel-tracking. If it is not provided, this information will not be displayed to the client. URL needs to be encoded in UTF-8 otherwise URLs containing more than one special character like '&' will be truncated.
- **carrier** (string) - Optional - Not a mandatory parameter.
- **shipping_date** (string) - Optional - Not Mandatory. shipping date, format « 2012-11-21 ». If it is not provided, the date taken into account will be the call date of this method.
- **estimated_delivery_date** (string) - Optional - Not Mandatory. If it is not provided, the information will not be transmitted to the customer.

#### Request Body
- **login** (string) - Required - Credentials for authentication
- **password** (string) - Required - Credentials for authentication

### Request Example
```curl
curl --location 'https://ws.monechelle.com?method=create_shipping&order_ref=M121100000002&tracking_number=C11124124511&tracking_url=http%253A%252F%252Fwww.laposte.fr%252Fsuivicolis%253Fnumero_colis%253DC11124124511&carrier=Collissimo&shipping_date=2021-02-15&estimated_delivery_date=2021-02-17' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

### Response
#### Success Response (200)
- **code** (string) - Indicates the status of the operation. `0` for success.
- **message** (string) - A message describing the result of the operation. `Success` for a successful operation.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
    <code>
        <![CDATA[0]]>
    </code>
    <message>
        <![CDATA[Success]]>
    </message>
    <datas></datas>
</content>
```
```

--------------------------------

### POST create_shipping

Source: https://www.manomano.dev/

Associates a tracking number with an order, sending an email notification to the client with shipping details and a tracking link.

```APIDOC
## POST create_shipping

### Description
This method is used to associate a tracking number to an order. An email will then be sent to the client to advise him about the shipping date and provide him with a link to a tracking interface on the carrier website.

### Method
POST

### Endpoint
https://ws.monechelle.com?method=create_shipping

### Parameters
#### Query Parameters
- **method** (string) - Required - create_shipping
- **order_ref** (string) - Required - M121100000002
- **tracking_number** (string) - Required - C11124124511
- **tracking_url** (string) - Required - http%3A%2F%2Fwww.laposte.fr%2Fsuivicolis%3Fnumero_colis%3DC11124124511
- **carrier** (string) - Required - Collissimo
- **shipping_date** (string) - Required - 2021-02-15
- **estimated_delivery_date** (string) - Required - 2021-02-17

### Response
#### Success Response (200)
- **code** (string) - Description: 0 for success
- **message** (string) - Description: Success message
- **datas** (string) - Description: Empty

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
<code><![CDATA[0]]></code>
<message><![CDATA[Success]]></message>
<datas></datas>
</content>
```
```

--------------------------------

### Create Shipping API Request

Source: https://www.manomano.dev/

This method associates a tracking number with an order. The request includes order reference, tracking number, tracking URL, carrier, shipping date, and estimated delivery date. An email with tracking information will be sent to the client upon successful execution.

```http
https://ws.monechelle.com?method=create_shipping &order_ref=M121100000002&tracking_number=C11124124511&tracking_url=http%3A%2F%2Fwww.laposte.fr%2Fsuivicolis%3Fnumero_colis%3DC11124124511&carrier=Collissimo&shipping_date=2021-02-15&estimated_delivery_date=2021-02-17
```

--------------------------------

### Refuse Order API Request

Source: https://www.manomano.dev/

Use this cURL command to send a request to refuse an order. Ensure the 'order_ref' is correctly formatted as 'M' followed by 12 digits. The 'User-Agent' header and form parameters 'login' and 'password' are also required.

```curl
curl --location 'https://ws.monechelle.com?method=refuse_order&order_ref=MM000000000000' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

--------------------------------

### Refuse Order API Success Response

Source: https://www.manomano.dev/

This is the expected XML response when an order is successfully refused. A 'code' of '0' indicates success, with a corresponding 'message'.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
<code><![CDATA[0]]></code>
<message><![CDATA[Success]]></message>
<datas></datas>
</content>
```

--------------------------------

### POST refuse_order

Source: https://www.manomano.dev/

Indicates to ManoMano that an order has been rejected. This action removes the order from the 'get_orders' list, initiates a refund, and changes the order status to 'Rejected'.

```APIDOC
## POST refuse_order

### Description
This method is used to indicate to manomano.com that the order displayed in the parameter has been rejected. Once an order has been rejected, it is no longer displayed in the list of orders returned by the “get_orders” method and will be refunded to the client. This method will change the status of the order. It will be displayed as “Rejected”.

### Method
POST

### Endpoint
https://ws.monechelle.com?method=refuse_order

### Parameters
#### Query Parameters
- **method** (string) - Required - refuse_order
- **order_ref** (string) - Required - The MM order reference (A letter M with 12 digits)

#### Request Body
- **login** (string) - Required - test
- **password** (string) - Required - test

### Request Example
```curl
curl --location 'https://ws.monechelle.com?method=refuse_order&order_ref=MM000000000000' \
--header 'User-Agent: CompanyName-V1.1' \
--form 'login="test"' \
--form 'password="test"'
```

### Response
#### Success Response (200)
- **code** (string) - Description: 0 for success
- **message** (string) - Description: Success message
- **datas** (string) - Description: Empty

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<content>
<code><![CDATA[0]]></code>
<message><![CDATA[Success]]></message>
<datas></datas>
</content>
```
```
Tokens:
Raw