### List plentymarkets Payment Methods using cURL

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet illustrates how to retrieve a list of all available payment method plugins within the plentymarkets system using a cURL GET request. Ensure you provide a valid authorization token.

```bash
# List all payment methods
curl -X GET "https://example.plentymarkets.com/rest/payments/methods" \
  -H "Authorization: Bearer your_access_token"
```

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

### GET /rest/payments/methods

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Retrieves all available payment method plugins configured in the system.

```APIDOC
## GET /rest/payments/methods

### Description
Retrieves all available payment method plugins configured in the system.

### Method
GET

### Endpoint
/rest/payments/methods

### Parameters
This endpoint does not have any specific parameters.

### Request Example
```bash
curl -X GET "https://example.plentymarkets.com/rest/payments/methods" \
  -H "Authorization: Bearer your_access_token"
```

### Response
#### Success Response (200)
The response is an array of payment method objects. Each object contains details about a payment method, such as its ID, name, and configuration options. The exact structure may vary based on the installed payment plugins.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Bank Transfer",
    "pluginName": "com.plentymarkets.payment.banktransfer",
    "active": true,
    "paymentFee": {
      "amount": 0,
      "currency": "EUR"
    },
    "paymentFeePercentage": 0
  },
  {
    "id": 2,
    "name": "Credit Card (Stripe)",
    "pluginName": "com.plentymarkets.payment.stripe",
    "active": true,
    "paymentFee": {
      "amount": 0.30,
      "currency": "EUR"
    },
    "paymentFeePercentage": 1.5
  }
]
```
```

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

### Search and List Items in Plentymarkets

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet shows how to retrieve items from the plentymarkets catalog using GET requests. It supports basic listing with pagination and advanced filtering by name, manufacturer, flags, date range, and related data. Item IDs can also be used for specific searches. Requires an authorization token.

```bash
# Basic item list
curl -X GET "https://example.plentymarkets.com/rest/items?page=1&itemsPerPage=50" \
  -H "Authorization: Bearer your_access_token"
```

```bash
# Advanced search with filters and related data
curl -X GET "https://example.plentymarkets.com/rest/items?\
name=Leather+Chair&\
manufacturerId=5&\
flagOne=1&\
flagTwo=3&\
lang=en&\
with=itemProperties,variations,itemImages,itemShippingProfiles&\
updatedBetween=2024-01-01,2024-12-31&\
page=1&\
itemsPerPage=25" \
  -H "Authorization: Bearer your_access_token"
```

```bash
# Search by specific item IDs
curl -X GET "https://example.plentymarkets.com/rest/items?\
id=102,103,104&\
with=variations" \
  -H "Authorization: Bearer your_access_token"
```

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

### List Item Variations in Plentymarkets

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet shows how to retrieve all variations of a specific item from the plentymarkets catalog using a GET request. It requires the item ID and an authorization token. The response will contain a list of variations associated with the specified item.

```bash
# Basic variation list for an item
curl -X GET "https://example.plentymarkets.com/rest/items/102/variations" \
  -H "Authorization: Bearer your_access_token"
```

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

### GET /rest/payments/methods

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Retrieves a list of payment methods available in the plentymarkets system, with options to filter for backend-searchable and backend-active methods.

```APIDOC
## GET /rest/payments/methods

### Description
Retrieves a list of available payment methods. Allows filtering by `backendSearchable` and `backendActive` status.

### Method
GET

### Endpoint
/rest/payments/methods

### Parameters
#### Query Parameters
- **backendSearchable** (boolean) - Optional - Filters for payment methods that are searchable in the backend.
- **backendActive** (boolean) - Optional - Filters for payment methods that are currently active in the backend.

### Request Example
```bash
curl -X GET "https://example.plentymarkets.com/rest/payments/methods?backendSearchable=true&backendActive=true" \
  -H "Authorization: Bearer your_access_token"
```

### Response
#### Success Response (200)
- **pluginKey** (string) - The key of the payment plugin.
- **paymentKey** (string) - The unique key for the payment method.
- **name** (string) - The display name of the payment method.

#### Response Example
```json
[
  {
    "pluginKey": "plenty",
    "paymentKey": "cash",
    "name": "Cash on delivery"
  },
  {
    "pluginKey": "plenty",
    "paymentKey": "invoice",
    "name": "Invoice"
  }
]
```
```

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

### Authentication API

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Handles authentication for backend users and session management.

```APIDOC
## POST /rest/login

### Description
Authenticates backend users and returns access tokens for subsequent API calls.

### Method
POST

### Endpoint
/rest/login

### Parameters
#### Request Body
- **username** (string) - Required - The backend username.
- **password** (string) - Required - The backend password.

### Request Example
```json
{
  "username": "your_backend_username",
  "password": "your_backend_password"
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - The access token for API authentication.
- **tokenType** (string) - The type of token, typically "Bearer".
- **expiresIn** (integer) - The token's expiration time in seconds.
- **refreshToken** (string) - The refresh token for obtaining new access tokens.

#### Response Example
```json
{
  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
  "tokenType": "Bearer",
  "expiresIn": 86400,
  "refreshToken": "def502001a9c8f..."
}
```

## POST /rest/logout

### Description
Invalidates the current access token and ends the authenticated session.

### Method
POST

### Endpoint
/rest/logout

### Parameters
#### Request Headers
- **Authorization** (string) - Required - Bearer token for authentication (e.g., "Bearer your_access_token").

### Response
#### Success Response (200)
Empty body.

#### Error Response (401)
- **error** (string) - Description of the authentication error.

#### Error Response Example
```json
{
  "error": "The resource owner or authorization server denied the request."
}
```
```

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

### Warehouse Management API

Source: https://context7.com/plentymarkets/api-doc/llms.txt

APIs for managing warehouses, including listing and creating warehouses.

```APIDOC
## GET /rest/stockmanagement/warehouses

### Description
Retrieves all warehouses configured in the system. You can optionally include related data like `repairWarehouse`.

### Method
GET

### Endpoint
/rest/stockmanagement/warehouses

### Query Parameters
- **with** (string) - Optional - Comma-separated list of related data to include (e.g., `repairWarehouse`).

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the warehouse.
- **name** (string) - The name of the warehouse.
- **note** (string) - Optional notes about the warehouse.
- **typeId** (integer) - The type ID of the warehouse.
- **onStockAvailability** (integer) - The quantity of items available in stock.
- **outOfStockAvailability** (integer) - The quantity of items out of stock.
- **splitByShippingProfile** (boolean) - Indicates if the warehouse splits by shipping profile.
- **storageLocationType** (string) - The type of storage location.
- **storageLocationZone** (integer) - The storage location zone.
- **isInventoryModeActive** (boolean) - Indicates if inventory mode is active.
- **logisticsType** (string) - The logistics type of the warehouse.
- **updatedAt** (string) - The timestamp when the warehouse was last updated.
- **createdAt** (string) - The timestamp when the warehouse was created.
- **address** (object) - Optional address details for the warehouse.
  - **name1** (string) - The first line of the name.
  - **name2** (string) - The second line of the name.
  - **address1** (string) - The first line of the address.
  - **address2** (string) - The second line of the address.
  - **postalCode** (string) - The postal code.
  - **town** (string) - The town or city.
  - **countryId** (integer) - The ID of the country.
  - **email** (string) - The email address.
  - **phone** (string) - The phone number.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Main Warehouse Hamburg",
    "note": "Primary distribution center",
    "typeId": 0,
    "onStockAvailability": 10,
    "outOfStockAvailability": 5,
    "splitByShippingProfile": true,
    "storageLocationType": "europallet",
    "storageLocationZone": 1,
    "isInventoryModeActive": false,
    "logisticsType": "own",
    "updatedAt": "2024-01-10T08:30:00+01:00",
    "createdAt": "2023-06-15T10:00:00+01:00",
    "address": {
      "name1": "plentymarkets GmbH",
      "name2": "Warehouse",
      "address1": "Hafenweg 22",
      "address2": "",
      "postalCode": "20539",
      "town": "Hamburg",
      "countryId": 1,
      "email": "warehouse@plentymarkets.com",
      "phone": "+49 40 1234567"
    }
  }
]
```

## POST /rest/stockmanagement/warehouses

### Description
Creates a new warehouse for inventory management.

### Method
POST

### Endpoint
/rest/stockmanagement/warehouses

### Request Body
- **name** (string) - Required - The name of the warehouse.
- **note** (string) - Optional - Notes about the warehouse.
- **typeId** (integer) - Required - The type ID of the warehouse.
- **onStockAvailability** (integer) - Required - The quantity of items available in stock.
- **outOfStockAvailability** (integer) - Required - The quantity of items out of stock.
- **splitByShippingProfile** (boolean) - Required - Indicates if the warehouse splits by shipping profile.
- **storageLocationType** (string) - Required - The type of storage location.
- **storageLocationZone** (integer) - Required - The storage location zone.
- **isInventoryModeActive** (boolean) - Required - Indicates if inventory mode is active.
- **logisticsType** (string) - Required - The logistics type of the warehouse.

### Request Example
```json
{
  "name": "Berlin Distribution Center",
  "note": "Secondary warehouse for East Germany",
  "typeId": 0,
  "onStockAvailability": 10,
  "outOfStockAvailability": 5,
  "splitByShippingProfile": false,
  "storageLocationType": "large",
  "storageLocationZone": 2,
  "isInventoryModeActive": false,
  "logisticsType": "own"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the newly created warehouse.
- **name** (string) - The name of the warehouse.
- **note** (string) - Optional notes about the warehouse.
- **typeId** (integer) - The type ID of the warehouse.
- **onStockAvailability** (integer) - The quantity of items available in stock.
- **outOfStockAvailability** (integer) - The quantity of items out of stock.
- **splitByShippingProfile** (boolean) - Indicates if the warehouse splits by shipping profile.
- **storageLocationType** (string) - The type of storage location.
- **storageLocationZone** (integer) - The storage location zone.
- **isInventoryModeActive** (boolean) - Indicates if inventory mode is active.
- **logisticsType** (string) - The logistics type of the warehouse.
- **createdAt** (string) - The timestamp when the warehouse was created.
- **updatedAt** (string) - The timestamp when the warehouse was last updated.
- **address** (object) - Address details for the warehouse.
  - **name1** (string) - The first line of the name.
  - **address1** (string) - The first line of the address.

#### Response Example
```json
{
  "id": 3,
  "name": "Berlin Distribution Center",
  "note": "Secondary warehouse for East Germany",
  "typeId": 0,
  "onStockAvailability": 10,
  "outOfStockAvailability": 5,
  "splitByShippingProfile": false,
  "storageLocationType": "large",
  "storageLocationZone": 2,
  "isInventoryModeActive": false,
  "logisticsType": "own",
  "createdAt": "2024-01-20T16:00:00+01:00",
  "updatedAt": "2024-01-20T16:00:00+01:00",
  "address": {
    "name1": null,
    "address1": null
  }
}
```
```

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

### Create plentymarkets Warehouse using cURL

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet demonstrates the process of creating a new warehouse for inventory management in plentymarkets using cURL. It specifies details such as name, type, and logistical settings. A valid authorization token is necessary.

```bash
curl -X POST https://example.plentymarkets.com/rest/stockmanagement/warehouses \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Berlin Distribution Center",
    "note": "Secondary warehouse for East Germany",
    "typeId": 0,
    "onStockAvailability": 10,
    "outOfStockAvailability": 5,
    "splitByShippingProfile": false,
    "storageLocationType": "large",
    "storageLocationZone": 2,
    "isInventoryModeActive": false,
    "logisticsType": "own"
  }'
```

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

### Authenticate with plentymarkets API

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Performs a POST request to authenticate backend users and obtain an access token. Requires username and password. The response includes the access token, token type, expiration time, and refresh token.

```bash
curl -X POST https://example.plentymarkets.com/rest/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your_backend_username",
    "password": "your_backend_password"
  }'
```

```json
{
  "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
  "tokenType": "Bearer",
  "expiresIn": 86400,
  "refreshToken": "def502001a9c8f..."
}
```

```bash
curl -X GET https://example.plentymarkets.com/rest/accounts/contacts \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
```

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

### Create plentymarkets Order using cURL

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet demonstrates how to create a new order in the plentymarkets system using a cURL request. It includes details for order items, properties, and relations. Ensure you replace 'your_access_token' with a valid token.

```bash
curl -X POST "https://example.plentymarkets.com/rest/orders?coupon=SAVE10" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "typeId": 1,
    "plentyId": 64487,
    "statusId": 3.0,
    "ownerId": 123,
    "lockStatus": "unlocked",
    "orderItems": [
      {
        "typeId": 1,
        "referrerId": 1,
        "itemVariationId": 1000,
        "quantity": 2,
        "orderItemName": "Modern Leather Chair Seattle - Green",
        "shippingProfileId": 6,
        "countryVatId": 1,
        "vatRate": 19,
        "amounts": [
          {
            "isSystemCurrency": true,
            "currency": "EUR",
            "priceOriginalGross": 399.99
          }
        ]
      }
    ],
    "properties": [
      {
        "typeId": 3,
        "value": "1"
      },
      {
        "typeId": 4,
        "value": "unpaid"
      }
    ],
    "addressRelations": [
      {
        "typeId": 1,
        "addressId": 5001
      },
      {
        "typeId": 2,
        "addressId": 5001
      }
    ],
    "relations": [
      {
        "referenceType": "contact",
        "referenceId": 1001,
        "relation": "receiver"
      }
    ]
  }'
```

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

### Create New Item in Plentymarkets

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet demonstrates how to add a new item to the plentymarkets catalog using a POST request. It requires an authorization token and a JSON payload with item properties. The response includes the newly created item's ID and other basic details.

```bash
curl -X POST https://example.plentymarkets.com/rest/items \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "position": 0,
    "stockType": 0,
    "storeSpecial": 2,
    "ownerId": 123,
    "manufacturerId": 5,
    "condition": 0,
    "conditionApi": 1000,
    "isSubscribable": false,
    "isShippingPackage": false,
    "amazonFbaPlatform": 0,
    "revenueAccount": 8400,
    "couponRestriction": 0
  }'
```

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

### Item Management API

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Endpoints for managing items in the plentymarkets catalog, including searching, listing, and creating items, as well as retrieving item variations.

```APIDOC
## GET /rest/items

### Description
Retrieves items from the catalog with support for complex filtering, pagination, and related data loading.

### Method
GET

### Endpoint
/rest/items

### Parameters
#### Query Parameters
- **name** (string) - Optional - Filter items by name.
- **manufacturerId** (integer) - Optional - Filter items by manufacturer ID.
- **flagOne** (integer) - Optional - Filter by flag one.
- **flagTwo** (integer) - Optional - Filter by flag two.
- **lang** (string) - Optional - Language for the item texts.
- **with** (string) - Optional - Comma-separated list of related data to load (e.g., `itemProperties,variations,itemImages,itemShippingProfiles`).
- **updatedBetween** (string) - Optional - Filter items updated between two dates (format: `YYYY-MM-DD,YYYY-MM-DD`).
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **itemsPerPage** (integer) - Optional - The number of items per page. Defaults to 25.
- **id** (string) - Optional - Comma-separated list of item IDs to search for.

### Request Example
```bash
# Basic item list
curl -X GET "https://example.plentymarkets.com/rest/items?page=1&itemsPerPage=50" \
  -H "Authorization: Bearer your_access_token"

# Advanced search with filters and related data
curl -X GET "https://example.plentymarkets.com/rest/items?\
name=Leather+Chair&\
manufacturerId=5&\
flagOne=1&\
flagTwo=3&\
lang=en&\
with=itemProperties,variations,itemImages,itemShippingProfiles&\
updatedBetween=2024-01-01,2024-12-31&\
page=1&\
itemsPerPage=25" \
  -H "Authorization: Bearer your_access_token"

# Search by specific item IDs
curl -X GET "https://example.plentymarkets.com/rest/items?\
id=102,103,104&\
with=variations" \
  -H "Authorization: Bearer your_access_token"
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **totalsCount** (integer) - The total number of items found.
- **isLastPage** (boolean) - Indicates if this is the last page.
- **lastPageNumber** (integer) - The number of the last page.
- **firstOnPage** (integer) - The index of the first item on the current page.
- **lastOnPage** (integer) - The index of the last item on the current page.
- **itemsPerPage** (integer) - The number of items per page.
- **entries** (array) - An array of item objects.
  - **id** (integer) - The item ID.
  - **position** (integer) - The position of the item.
  - **manufacturerId** (integer) - The manufacturer ID.
  - **stockType** (integer) - The stock type.
  - **storeSpecial** (integer) - The store special flag.
  - **condition** (integer) - The condition of the item.
  - **isSubscribable** (boolean) - Indicates if the item is subscribable.
  - **mainVariationId** (integer) - The ID of the main variation.
  - **flagOne** (integer) - The flag one value.
  - **flagTwo** (integer) - The flag two value.
  - **createdAt** (string) - The creation date.
  - **updatedAt** (string) - The update date.
  - **texts** (array) - Array of item text objects for different languages.
    - **lang** (string) - The language code.
    - **name1** (string) - The first name field.
    - **name2** (string) - The second name field.
    - **name3** (string) - The third name field.
    - **shortDescription** (string) - The short description.
    - **description** (string) - The full description.
    - **keywords** (string) - Keywords associated with the item.
    - **technicalData** (string) - Technical data of the item.

#### Response Example
```json
{
  "page": 1,
  "totalsCount": 1458,
  "isLastPage": false,
  "lastPageNumber": 59,
  "firstOnPage": 1,
  "lastOnPage": 25,
  "itemsPerPage": 25,
  "entries": [
    {
      "id": 102,
      "position": 0,
      "manufacturerId": 2,
      "stockType": 0,
      "storeSpecial": 1,
      "condition": 0,
      "isSubscribable": false,
      "mainVariationId": 1000,
      "flagOne": 1,
      "flagTwo": 3,
      "createdAt": "2023-12-24T00:00:00+01:00",
      "updatedAt": "2024-09-05T13:07:00+02:00",
      "texts": [
        {
          "lang": "en",
          "name1": "Modern Leather Chair Seattle - Green",
          "name2": "Seattle",
          "name3": "Premium Seating",
          "shortDescription": "Design with elegance. Highest quality.",
          "description": "<p>Sophisticated design meets exceptional comfort...</p>",
          "keywords": "chair, leather, modern, green, furniture",
          "technicalData": ""
        },
        {
          "lang": "de",
          "name1": "Moderner Ledersessel Seattle - Grün",
          "name2": "Seattle",
          "name3": "Premium Sitzgelegenheit",
          "shortDescription": "Design mit Schwung. Qualität höchster Güte.",
          "description": "<p>Anspruchsvolles Design trifft auf außergewöhnlichen Komfort...</p>",
          "keywords": "sessel, leder, modern, grün, möbel"
        }
      ]
    }
  ]
}
```

## POST /rest/items

### Description
Adds a new item to the plentymarkets catalog.

### Method
POST

### Endpoint
/rest/items

### Parameters
#### Request Body
- **position** (integer) - Optional - The position of the item.
- **stockType** (integer) - Optional - The stock type.
- **storeSpecial** (integer) - Optional - The store special flag.
- **ownerId** (integer) - Optional - The owner ID.
- **manufacturerId** (integer) - Optional - The manufacturer ID.
- **condition** (integer) - Optional - The condition of the item.
- **conditionApi** (integer) - Optional - The API condition.
- **isSubscribable** (boolean) - Optional - Indicates if the item is subscribable.
- **isShippingPackage** (boolean) - Optional - Indicates if the item is a shipping package.
- **amazonFbaPlatform** (integer) - Optional - Amazon FBA platform setting.
- **revenueAccount** (integer) - Optional - The revenue account.
- **couponRestriction** (integer) - Optional - Coupon restriction setting.

### Request Example
```bash
curl -X POST https://example.plentymarkets.com/rest/items \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{ 
    "position": 0, 
    "stockType": 0, 
    "storeSpecial": 2, 
    "ownerId": 123, 
    "manufacturerId": 5, 
    "condition": 0, 
    "conditionApi": 1000, 
    "isSubscribable": false, 
    "isShippingPackage": false, 
    "amazonFbaPlatform": 0, 
    "revenueAccount": 8400, 
    "couponRestriction": 0 
  }'
```

### Response
#### Success Response (200)
- **id** (integer) - The newly created item's ID.
- **position** (integer) - The position of the item.
- **stockType** (integer) - The stock type.
- **storeSpecial** (integer) - The store special flag.
- **ownerId** (integer) - The owner ID.
- **manufacturerId** (integer) - The manufacturer ID.
- **condition** (integer) - The condition of the item.
- **conditionApi** (integer) - The API condition.
- **isSubscribable** (boolean) - Indicates if the item is subscribable.
- **isShippingPackage** (boolean) - Indicates if the item is a shipping package.
- **amazonFbaPlatform** (integer) - Amazon FBA platform setting.
- **revenueAccount** (integer) - The revenue account.
- **couponRestriction** (integer) - Coupon restriction setting.
- **mainVariationId** (integer) - The ID of the main variation.
- **createdAt** (string) - The creation date.
- **updatedAt** (string) - The update date.

#### Response Example
```json
{
  "id": 1523,
  "position": 0,
  "stockType": 0,
  "storeSpecial": 2,
  "ownerId": 123,
  "manufacturerId": 5,
  "condition": 0,
  "conditionApi": 1000,
  "isSubscribable": false,
  "isShippingPackage": false,
  "amazonFbaPlatform": 0,
  "revenueAccount": 8400,
  "couponRestriction": 0,
  "mainVariationId": 15230,
  "createdAt": "2024-01-20T11:30:00+01:00",
  "updatedAt": "2024-01-20T11:30:00+01:00"
}
```

## GET /rest/items/{itemId}/variations

### Description
Retrieves all variations of a specific item with comprehensive filtering options.

### Method
GET

### Endpoint
/rest/items/{itemId}/variations

### Parameters
#### Path Parameters
- **itemId** (integer) - Required - The ID of the item for which to retrieve variations.

### Request Example
```bash
# Basic variation list for an item
curl -X GET "https://example.plentymarkets.com/rest/items/102/variations" \
  -H "Authorization: Bearer your_access_token"
```

### Response
#### Success Response (200)
*This endpoint returns an array of variation objects. The exact structure depends on the item and its configured variations.* 

#### Response Example
*Example response structure (may vary):
```json
[
  {
    "id": 1000,
    "itemId": 102,
    "orderNr": 1,
    "name": "Green Leather - Small",
    "ean": "4000000000100",
    "stockType": 0,
    "warehouseId": 1,
    "availableUntil": null,
    "price": {
      "amount": 199.99,
      "currency": "EUR"
    }
  }
]
```
```

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

### POST /rest/orders

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Creates a new order in the plentymarkets system. You can optionally apply a coupon code.

```APIDOC
## POST /rest/orders

### Description
Creates a new order in the plentymarkets system. You can optionally apply a coupon code using the `coupon` query parameter.

### Method
POST

### Endpoint
/rest/orders

### Query Parameters
- **coupon** (string) - Optional - A coupon code to apply to the order.

### Request Body
- **typeId** (integer) - Required - The type of the order.
- **plentyId** (integer) - Required - The plentymarkets ID for the order.
- **statusId** (float) - Required - The initial status ID of the order.
- **ownerId** (integer) - Required - The ID of the owner of the order.
- **lockStatus** (string) - Required - The lock status of the order (e.g., "unlocked").
- **orderItems** (array) - Required - An array of order items.
  - **typeId** (integer) - Required - The type ID of the order item.
  - **referrerId** (integer) - Required - The referrer ID for the order item.
  - **itemVariationId** (integer) - Required - The ID of the item variation.
  - **quantity** (integer) - Required - The quantity of the item.
  - **orderItemName** (string) - Required - The name of the order item.
  - **shippingProfileId** (integer) - Required - The shipping profile ID.
  - **countryVatId** (integer) - Required - The country VAT ID.
  - **vatRate** (float) - Required - The VAT rate for the item.
  - **amounts** (array) - Required - An array of amounts for the item.
    - **isSystemCurrency** (boolean) - Required - Indicates if the amount is in the system currency.
    - **currency** (string) - Required - The currency code (e.g., "EUR").
    - **priceOriginalGross** (float) - Required - The original gross price.
- **properties** (array) - Optional - An array of properties for the order.
  - **typeId** (integer) - Required - The type ID of the property.
  - **value** (string) - Required - The value of the property.
- **addressRelations** (array) - Required - An array of address relations.
  - **typeId** (integer) - Required - The type ID of the address relation.
  - **addressId** (integer) - Required - The ID of the address.
- **relations** (array) - Required - An array of relations for the order.
  - **referenceType** (string) - Required - The type of reference (e.g., "contact").
  - **referenceId** (integer) - Required - The ID of the reference.
  - **relation** (string) - Required - The relation type (e.g., "receiver").

### Request Example
```json
{
  "typeId": 1,
  "plentyId": 64487,
  "statusId": 3.0,
  "ownerId": 123,
  "lockStatus": "unlocked",
  "orderItems": [
    {
      "typeId": 1,
      "referrerId": 1,
      "itemVariationId": 1000,
      "quantity": 2,
      "orderItemName": "Modern Leather Chair Seattle - Green",
      "shippingProfileId": 6,
      "countryVatId": 1,
      "vatRate": 19,
      "amounts": [
        {
          "isSystemCurrency": true,
          "currency": "EUR",
          "priceOriginalGross": 399.99
        }
      ]
    }
  ],
  "properties": [
    {
      "typeId": 3,
      "value": "1"
    },
    {
      "typeId": 4,
      "value": "unpaid"
    }
  ],
  "addressRelations": [
    {
      "typeId": 1,
      "addressId": 5001
    },
    {
      "typeId": 2,
      "addressId": 5001
    }
  ],
  "relations": [
    {
      "referenceType": "contact",
      "referenceId": 1001,
      "relation": "receiver"
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created order.
- **typeId** (integer) - The type of the order.
- **plentyId** (integer) - The plentymarkets ID for the order.
- **statusId** (float) - The status ID of the order.
- **statusName** (string) - The name of the order status.
- **ownerId** (integer) - The ID of the owner of the order.
- **lockStatus** (string) - The lock status of the order.
- **locationId** (null) - The location ID (currently null).
- **createdAt** (string) - The creation timestamp of the order.
- **updatedAt** (string) - The last update timestamp of the order.
- **properties** (array) - An array of properties for the order.
  - **orderId** (integer) - The ID of the order associated with the property.
  - **typeId** (integer) - The type ID of the property.
  - **value** (string) - The value of the property.
- **dates** (array) - An array of dates related to the order.
  - **orderId** (integer) - The ID of the order associated with the date.
  - **typeId** (integer) - The type ID of the date.
  - **date** (string) - The date value.
- **relations** (array) - An array of relations for the order.
  - **orderId** (integer) - The ID of the order associated with the relation.
  - **referenceType** (string) - The type of reference.
  - **referenceId** (integer) - The ID of the reference.
  - **relation** (string) - The relation type.

#### Response Example
```json
{
  "id": 1235,
  "typeId": 1,
  "plentyId": 64487,
  "statusId": 3.0,
  "statusName": "Waiting for payment",
  "ownerId": 123,
  "lockStatus": "unlocked",
  "locationId": null,
  "createdAt": "2024-01-20T15:45:00+01:00",
  "updatedAt": "2024-01-20T15:45:00+01:00",
  "properties": [
    {
      "orderId": 1235,
      "typeId": 3,
      "value": "1"
    },
    {
      "orderId": 1235,
      "typeId": 4,
      "value": "unpaid"
    }
  ],
  "dates": [
    {
      "orderId": 1235,
      "typeId": 2,
      "date": "2024-01-20T15:45:00+01:00"
    }
  ],
  "relations": [
    {
      "orderId": 1235,
      "referenceType": "contact",
      "referenceId": 1001,
      "relation": "receiver"
    }
  ]
}
```
```

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

### Create New Contact in Plentymarkets

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet demonstrates how to create a new customer contact in the plentymarkets system using a POST request. It requires an authorization token and a JSON payload containing contact details. The response includes the newly created contact's ID and other relevant information.

```bash
curl -X POST https://example.plentymarkets.com/rest/accounts/contacts \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "typeId": 1,
    "referrerId": 1,
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "title": "Ms.",
    "email": "jane.doe@example.com",
    "formOfAddress": "informal",
    "rating": 5,
    "classId": 1,
    "plentyId": 64487,
    "options": [
      {
        "typeId": 1,
        "subTypeId": 4,
        "value": "+49 123 456789",
        "priority": 0
      }
    ]
  }'
```

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

### List plentymarkets Warehouses using cURL

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This snippet shows how to retrieve a list of all warehouses configured in the plentymarkets system. An optional query parameter 'with=repairWarehouse' can be added to include repair warehouse relations. Requires a valid access token.

```bash
# Basic warehouse list
curl -X GET "https://example.plentymarkets.com/rest/stockmanagement/warehouses" \
  -H "Authorization: Bearer your_access_token"

# Include repair warehouse relations
curl -X GET "https://example.plentymarkets.com/rest/stockmanagement/warehouses?with=repairWarehouse" \
  -H "Authorization: Bearer your_access_token"
```

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

### Filter Backend Searchable Payment Methods (curl)

Source: https://context7.com/plentymarkets/api-doc/llms.txt

This command filters payment methods available in the plentymarkets API. It specifically requests methods that are searchable and active in the backend, requiring an authorization token for access. The output is typically a JSON array of payment method objects.

```shell
curl -X GET "https://example.plentymarkets.com/rest/payments/methods?backendSearchable=true&backendActive=true" \
  -H "Authorization: Bearer your_access_token"
```

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

### List plentymarkets contacts with filters

Source: https://context7.com/plentymarkets/api-doc/llms.txt

Retrieves a list of contacts with options for basic pagination and advanced filtering by various criteria like email, type, rating, and dates. Supports full-text search and including related data entities.

```bash
# Basic contact list
curl -X GET "https://example.plentymarkets.com/rest/accounts/contacts?page=1&itemsPerPage=50" \
  -H "Authorization: Bearer your_access_token"
```

```bash
# Advanced filtering with related data
curl -X GET "https://example.plentymarkets.com/rest/accounts/contacts?email=customer@example.com&typeId=1&rating=5&createdAtAfter=2024-01-01&updatedAtBefore=2024-12-31&with=addresses,accounts,orderSummary,primaryBillingAddress&page=1&itemsPerPage=25" \
  -H "Authorization: Bearer your_access_token"
```

```bash
# Fulltext search
curl -X GET "https://example.plentymarkets.com/rest/accounts/contacts?fullText=John+Smith&with=addresses" \
  -H "Authorization: Bearer your_access_token"
```

```json
{
  "page": 1,
  "totalsCount": 156,
  "isLastPage": false,
  "lastPageNumber": 7,
  "firstOnPage": 1,
  "lastOnPage": 25,
  "itemsPerPage": 25,
  "entries": [
    {
      "id": 1001,
      "number": "C10001",
      "externalId": "EXT-12345",
      "typeId": 1,
      "firstName": "John",
      "lastName": "Smith",
      "fullName": "John Smith",
      "gender": "male",
      "title": "Mr.",
      "email": "john.smith@example.com",
      "secondaryEmail": "",
      "formOfAddress": "formal",
      "blocked": false,
      "rating": 5,
      "classId": 1,
      "plentyId": 64487,
      "userId": 123,
      "referrerId": 1,
      "birthdayAt": "1985-06-15",
      "lastLoginAt": "2024-01-15T10:30:00+01:00",
      "lastOrderAt": "2024-01-10T14:25:00+01:00",
      "createdAt": "2023-03-01T09:00:00+01:00",
      "updatedAt": "2024-01-15T10:30:00+01:00",
      "options": []
    }
  ]
}
```