Flxpoint API

https://flxpoint.stoplight.io
Admin
Flxpoint API enables developers to automate ecommerce operations and integrate supplier sources and...
Tokens:5,772
Snippets:54
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Simple Content Inventory Payload for POST /inventory

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Use this JSON payload with the POST /inventory endpoint to create or update inventory records. It contains a list of parent objects, each with a required sku and a variants array. The example shows two parents with their variants, including quantity and cost fields.

```json
[{
"sku" : "SKU123",
"variants" : [{
"sku" : "SKU123",
"quantity" : 5,
"cost" : 7.99
}]
},{
"sku" : "SKU456",
"variants" : [{
"sku" : "SKU456",
"quantity" : 10,
"cost" : 4.99
}]
}]
```

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

### GET /fulfillment-requests

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Retrieve fulfillment requests that are in a Processing state. Accepts a filterStatus query parameter to filter by status.

```APIDOC
## GET /fulfillment-requests

### Description
Retrieve Fulfillment Requests that are ready to be sent to a Source. Use the `filterStatus` query parameter to filter by status, typically `Processing`.

### Method
GET

### Endpoint
/fulfillment-requests

### Query Parameters
- `filterStatus` (string) - Optional - Filter by status, e.g., `Processing`.

### Request Example
```http
GET /fulfillment-requests?filterStatus=Processing
```

### Response
No response schema provided in source.
```

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

### POST /source-invoices

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Create invoices when they become available.

```APIDOC
## POST /source-invoices

### Description
Create invoices when they become available for the Source.

### Method
POST

### Endpoint
/source-invoices

### Request Body
No request schema provided in source.

### Response Body
No response schema provided in source.
```

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

### POST /shipments

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Create shipments that become available for the Source.

```APIDOC
## POST /shipments

### Description
Create shipments to notify Flxpoint about shipment tracking updates.

### Method
POST

### Endpoint
/shipments

### Request Body
No request schema provided in source.

### Response Body
No response schema provided in source.
```

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

### POST /inventory

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Create or update inventory records with simple content. Accepts a list of parents and variants, limited to 20 parents per request.

```APIDOC
## POST /inventory

### Description
Create or update inventory records with simple content. Pass a list of parents and variants. The endpoint is restricted to 20 parents per request.

### Method
POST

### Endpoint
/inventory

### Request Body
- `sku` (string) - Required - Parent SKU. If no parent data, replicate the variant SKU.
- `variants` (array) - Required - List of variant objects with fields:
  - `sku` (string) - Required - Variant SKU.
  - `quantity` (integer) - Required - Inventory quantity.
  - `cost` (number) - Required - Unit cost.

### Request Example
```json
[
  {
    "sku": "SKU123",
    "variants": [
      {
        "sku": "SKU123",
        "quantity": 5,
        "cost": 7.99
      }
    ]
  },
  {
    "sku": "SKU456",
    "variants": [
      {
        "sku": "SKU456",
        "quantity": 10,
        "cost": 4.99
      }
    ]
  }
]
```

### Response
No response schema provided in source.
```

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

### PUT /inventory/variants

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Update inventory variants more efficiently than with POST /inventory, allowing faster inventory updates.

```APIDOC
## PUT /inventory/variants

### Description
Update inventory variants. This endpoint allows for faster inventory updates compared to POST /inventory.

### Method
PUT

### Endpoint
/inventory/variants

### Parameters
No parameters documented in source.

### Request Body
No request body schema provided in source.

### Response
No response schema provided in source.
```

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

### Orders - Sync Accounting

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/bivtv95ysvtyr-accounting-sync

Endpoints for syncing orders to an external accounting system. Retrieve orders that need to be synced and update them to indicate they have been synced.

```APIDOC
## GET /orders

### Description
Retrieve orders to be synced to the accounting system. Use this endpoint to fetch orders that need to be synced, applying the recommended filters.

### Method
GET

### Endpoint
/orders

### Parameters
#### Query Parameters
- **channelId** (string) - Optional - ID of the channel.
- **paymentStatus** (string) - Optional - Payment status filter. Allowed values: `Paid`, `Deferred`.
- **accountingSynced** (boolean) - Optional - Set to `false` to retrieve orders that have not been synced.

### Response
#### Success Response (200)
Returns a list of orders that match the specified filters.

#### Response Example
```json
[
  {
    "id": 0,
    "channelId": "string",
    "paymentStatus": "Paid",
    "accountingSynced": false
  }
]
```

## PATCH /orders/{id}/accounting-sync

### Description
Update orders in Flxpoint to indicate they have been synced to the accounting system. Use this endpoint to save orders as synced after successfully syncing them.

### Method
PATCH

### Endpoint
/orders/{id}/accounting-sync

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the order to update.

#### Request Body
- **accountingSynced** (boolean) - Required - Set to `true` to indicate the order has been synced.
- **externalAccountingId** (string) - Optional - The external accounting system's ID for the order.
- **items** (array) - Optional - List of items that were synced.
  - **id** (integer) - Required - The ID of the item.
  - **externalAccountingId** (string) - Optional - The external accounting system's ID for the item.

### Request Example
```json
{
  "accountingSynced": true,
  "externalAccountingId": "string",
  "items": [
    {
      "id": 0,
      "externalAccountingId": "string"
    }
  ]
}
```

### Response
#### Success Response (200)
Returns the updated order object.

#### Response Example
```json
{
  "id": 0,
  "accountingSynced": true,
  "externalAccountingId": "string",
  "items": [
    {
      "id": 0,
      "externalAccountingId": "string"
    }
  ]
}
```
```

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

### PATCH /fulfillment-requests/{fulfillmentRequestId}/acknowledge

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Acknowledge a Fulfillment Request after successful retrieval/import, modifying its state to 'acknowledged' and filtering it from subsequent requests.

```APIDOC
## PATCH /fulfillment-requests/{fulfillmentRequestId}/acknowledge

### Description
Acknowledge a Fulfillment Request once retrieved/imported successfully. Changes its state to 'acknowledged' and excludes it from later polls.

### Method
PATCH

### Endpoint
/fulfillment-requests/{fulfillmentRequestId}/acknowledge

### Path Parameters
- `fulfillmentRequestId` (string) - Required - Unique ID of the Fulfillment Request to acknowledge.

### Response
No response schema provided in source.
```

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

### POST /fulfillment-requests/{fulfillmentRequestId}/adjust

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Cancel specific items of a Fulfillment Request.

```APIDOC
## POST /fulfillment-requests/{fulfillmentRequestId}/adjust

### Description
Cancel specific items of a Fulfillment Request. Use this instead of canceling the entire request.

### Method
POST

### Endpoint
/fulfillment-requests/{fulfillmentRequestId}/adjust

### Path Parameters
- `fulfillmentRequestId` (string) - Required: Unique ID of the Fulfillment Request to adjust.

### Request Body
No request body schema provided in source.

### Response Body
No response schema provided in source.
```

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

### Update Order Accounting Sync Status

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/bivtv95ysvtyr-accounting-sync

Use the PATCH /orders/{id}/accounting-sync endpoint to mark an order as synced in Flxpoint.

```json
{
  "accountingSynced": true,
  "externalAccountingId": "string",
  "items": [
    {
      "id": 0,
      "externalAccountingId": "string"
    }
  ]
}
```

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

### PATCH /fulfillment-requests/{fulfillmentRequestId}/cancel

Source: https://flxpoint.stoplight.io/docs/flxpoint-api/ZG9jOjQ2ODk1MjEx-integrating-as-a-source

Cancel an entire Fulfillment Request by its ID.

```APIDOC
## PATCH /fulfillment-requests/{fulfillmentRequestId}/cancel

### Description
Cancel an entire Fulfillment Request by fulfillmentRequestId.

### Method
PATCH

### Endpoint
/fulfillment-requests/{fulfillmentRequestId}/cancel

### Path Parameters
- `fulfillmentRequestId` (string) - Required: Unique ID of the Fulfillment Request to cancel.

### Response Body
No response schema provided in source.
```
Tokens:
Raw