Partners

Partners represent the organizations you work with in Consignly, including clients (customers whose inventory you store/ship) and carriers (transport providers).

Endpoints Overview

Get Partners Page

Retrieve a paginated list of partners with optional filters.

Endpoint: GET /v1/partners

Query Parameters

Partner Relationship Values

Partner Status Values

Request Example

curl -X GET "https://api.consignlyhq.com/v1/partners?PageIndex=1&PageSize=50&Relationship=1&Status=1" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "index": 1,
  "total": 75,
  "partners": [
    {
      "id": "550e8400-e29b-41d4-a716-446655442000",
      "externalId": "EXT-001",
      "name": "Example Client Ltd",
      "code": "ECL",
      "email": "contact@exampleclient.com",
      "relationship": 1,
      "status": 2
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655442001",
      "externalId": null,
      "name": "Fast Freight Co",
      "code": "FFC",
      "email": "ops@fastfreight.com",
      "relationship": 2,
      "status": 2
    }
  ]
}

Response Fields

Get Partner Details

Retrieve detailed information for a specific partner.

Endpoint: GET /v1/partners/{partnerId}

Path Parameters

Request Example

curl -X GET "https://api.consignlyhq.com/v1/partners/550e8400-e29b-41d4-a716-446655442000" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "id": "550e8400-e29b-41d4-a716-446655442000",
  "externalId": "EXT-001",
  "relationship": 1,
  "status": 2,
  "name": "Example Client Ltd",
  "code": "ECL",
  "email": "contact@exampleclient.com",
  "freightResolution": 0,
  "freightWarningType": 1,
  "freightWarningThreshold": 50.0,
  "containerThresholdDays": 14,
  "rotationMethod": 2,
  "rotationMethodSecondary": 0,
  "productBatchUsage": 2,
  "productBestBeforeDateUsage": 1,
  "productExpiryUsage": 3,
  "productPackagingDateUsage": 1,
  "productProductionDateUsage": 1,
  "productSellByDateUsage": 1,
  "productSubstitution": 1,
  "productBatchSubstitution": 1,
  "productBestBeforeDateSubstitution": 2,
  "productExpirySubstitution": 2,
  "productPackagingDateSubstitution": 1,
  "productProductionDateSubstitution": 1,
  "productSellByDateSubstitution": 1,
  "productSerialSubstitution": 2,
  "productBestBeforeDateCriticalThresholdDays": 30,
  "productExpiryCriticalThresholdDays": 14,
  "productPackagingDateCriticalThresholdDays": null,
  "productProductionDateCriticalThresholdDays": null,
  "productSellByDateCriticalThresholdDays": null,
  "freeStorageHours": 48.0,
  "unitTypes": [
    {
      "id": "550e8400-e29b-41d4-a716-446655442050",
      "name": "Pallet",
      "status": 1
    }
  ]
}

Detail Response Fields

Freight Resolution Values

Freight Warning Type Values

Rotation Method Values

Product Attribute Usage Values

Product Substitution Values

Download Partner Logo

Download the original logo file for a partner.

Endpoint: GET /v1/partners/{partnerId}/logo

Path Parameters

Request Example

curl -X GET "https://api.consignlyhq.com/v1/partners/550e8400-e29b-41d4-a716-446655442000/logo" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  --output partner-logo.png

Response

Status: 200 OK

Returns the binary file content of the logo with appropriate Content-Type and Content-Disposition headers.

Error Cases

Download Partner Logo Thumbnail

Download the thumbnail version of a partner's logo.

Endpoint: GET /v1/partners/{partnerId}/logo-thumbnail

Path Parameters

Request Example

curl -X GET "https://api.consignlyhq.com/v1/partners/550e8400-e29b-41d4-a716-446655442000/logo-thumbnail" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  --output partner-logo-thumbnail.png

Response

Status: 200 OK

Returns the binary file content of the logo thumbnail with appropriate Content-Type and Content-Disposition headers.

Error Cases

Upload Partner Logo

Upload or replace a partner's logo.

Endpoint: PUT /v1/partners/{partnerId}/logo

Path Parameters

Request Body

{
  "logo": {
    "fileName": "partner-logo.png",
    "contentType": "image/png",
    "content": "<base64-encoded-file-content>",
    "options": {
      "printType": null
    }
  }
}

Request Example

curl -X PUT "https://api.consignlyhq.com/v1/partners/550e8400-e29b-41d4-a716-446655442000/logo" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "logo": {
      "fileName": "partner-logo.png",
      "contentType": "image/png",
      "content": "<base64-encoded-file-content>"
    }
  }'

Response

Status: 200 OK

Using Partner Codes

Partner codes are used throughout the API for creating consignments:

In Consignment Import

{
  "clientCode": "ECL",
  "carrierCode": "FFC",
  ...
}

Finding the Right Partner

1. Use the list endpoint with SearchText to find partners by name
2. Filter by Relationship to narrow down to clients or carriers
3. Use the partner code in import requests

Error Cases

Notes and Implementation Details

• AuthContext partner override: Several partner and partner-product endpoints support partner-scoped tokens. If the caller's token is partner-scoped, the server may override the partnerId path parameter with AuthContext.PartnerId. This makes partner clients able to call endpoints without supplying their partner ID.
• Paging defaults & limits: The list endpoints use predicate models (PartnerPredicateModel, PartnerProductPredicateModel) with defaults and validator-enforced limits (default PageSize and MaxPageSize). Consumers should assume server-side defaults if not provided and respect maximums returned by validation errors.
• File responses: Logo endpoints return raw file streams (with Content-Type and a filename). When the logo is not present the endpoint returns 404.
• Products are client-only: Only partners with relationship Client (customers) have associated products. Product endpoints enforce this and will return 404 or validation errors when used for non-client partners.

Related Endpoints

• Partner Products - Products for a partner
• Partner Schedules - Scheduling information
• Consignment Import - Create consignments using partner codes