Get one of the calling vendor's fulfilment groups

GET

/api/v1/vendor/orders/{groupId}

const url = 'https://api-omni.linra.net/api/v1/vendor/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-omni.linra.net/api/v1/vendor/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns a single fulfilment group by ID, scoped to the calling vendor. A group belonging to another vendor is reported as 404. Requires the Orders capability.

Authorizations

vendorBearer

Parameters

Path Parameters

groupId

required

string format: uuid

Responses

200

The fulfilment group.

application/json

object

state

required

string

payload

required

details

object

payload

required

Deliberately EXCLUDES the reselling partner’s identity, any customer/external reference, and every money/tax field (order total, commission, VAT, currency, discounts, tax-registration numbers) and the internal saga correlation id — none of it is the vendor’s business. You are paid via your own commercial terms with Linra, tracked entirely on the offer/cost-push side, never derived from what a partner paid.

object

groupId

string format: uuid

orderGlobalId

Linra’s own canonical order id — stable across both sides for support/correlation. Never the partner’s own external reference.

string

status

string

Allowed values: Pending Packed Shipped Delivered Cancelled Returned PendingSourcing

vendorOrderId

Your own order/reference id at your end, if previously pushed.

string

nullable

trackingRef

string

nullable

packedAt

string format: date-time

nullable

shippedAt

string format: date-time

nullable

deliveredAt

string format: date-time

nullable

shipRecipient

string

shipLine1

string

shipLine2

string

nullable

shipCity

string

shipRegion

string

nullable

shipPostalCode

string

nullable

shipCountry

string

shipPhone

string

lines

Array<object>

Trimmed to exactly what’s needed to pack the shipment. No money field of any kind is present.

object

lineId

string format: uuid

variantId

string format: uuid

sku

The catalog SKU for this variant, resolved regardless of the variant’s current active state.

string

quantity

integer

Example

{
  "state": "SUCCESS",
  "payload": {
    "status": "Pending"
  }
}

403

Your token doesn’t carry the capability this endpoint requires.

application/json

object

state

required

string

payload

details

object

Examples

missingCapability

{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

404

Unknown fulfilment group id, or one belonging to another vendor.

application/json

object

state

required

string

payload

details

object

Examples

notFound

{
  "state": "NOT_FOUND_FULFILLMENT_GROUP",
  "payload": null,
  "details": {}
}

429

Too many requests. Retry after the Retry-After header (seconds).

application/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Retry-After

integer

Seconds to wait before retrying.