Connections

Get fulfillment options

Shows the delivery modes the marketplace account has.

GET
/v1/connections/{id}/fulfillment-options

List delivery modes

  • MockDevelopment only
  • Mercado LivreNot supported
  • MagaluPlanned
  • AmazonPlanned
  • TikTok ShopPlanned
  • ShopeePlanned

Returns one Connection object (not a list, and not paginated) with options. Each option has the mode (seller_ship, marketplace_logistics, marketplace_fulfillment or pickup), the externalId, the label and whether it is available now.

Use it to know whether the seller can choose, for example, shipping by themselves or using the marketplace logistics before publishing.

Part of Publish listings. Synchronous read, no Job, as in List categories.

Authorization

api_key
headerAuthorizationBearer <token>

API key (mk_...)

Path Parameters

id*string

Identifier of the resource, as returned by the API.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Every delivery mode the marketplace offers this account, each with whether it is available now. Not paginated: it is a document of the connection.

application/json
  1. response

The delivery modes of one connection.

connectionId*string

The connection these options are for.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
options*array<>

Every delivery mode the marketplace offers this account.

Itemsitems <= 20
curl -X GET "https://example.com/v1/connections/3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01/fulfillment-options"
{  "connectionId": "3f7d8a57-3e44-4c91-bbf1-02d9f4e4e5b0",  "options": [    {      "mode": "seller_ship",      "externalId": "mock-seller-ship",      "label": "Seller ships",      "available": true,      "marketplaceData": {}    },    {      "mode": "marketplace_fulfillment",      "externalId": "mock-fulfillment",      "label": "Marketplace fulfillment",      "available": false,      "marketplaceData": {}    }  ]}