Shop
The 5 operations under shop, as typed calls on the generated REST client.
Available from @codespar/sdk 0.12.0; the version on npm is 0.16.28. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.27, the version this site installs: a call that does not type-check against it fails the build.
Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.
import { } from "@codespar/sdk";
const = new ({ : .. });GET /v1/shop/agent/instruments
The calling person's cards, masked
const = await ..("get", "/v1/shop/agent/instruments");
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: GET /v1/shop/agent/instruments in the HTTP reference.
POST /v1/shop/agent/purchases
Propose a purchase at a supported store (never an order)
const = await ..("post", "/v1/shop/agent/purchases", {
: {
: "agt_0000000000000000",
: "string",
: [
{
: "sku_0000000000000000",
: 0
}
],
: "offer_0000000000000000",
: 0,
: "card",
: "string"
}
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/shop/agent/purchases in the HTTP reference.
GET /v1/shop/agent/purchases/{id}
Where a purchase stands
const = await ..("get", "/v1/shop/agent/purchases/{id}", {
: {
: "purchase_0000000000000000"
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: GET /v1/shop/agent/purchases/{id} in the HTTP reference.
POST /v1/shop/agent/research
Research a pedido aberto: offers compared, one recommendation
const = await ..("post", "/v1/shop/agent/research", {
: {
: "string",
: {
: "total",
: 1,
: [
"registry"
],
: 1000
}
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/shop/agent/research in the HTTP reference.
GET /v1/shop/agent/research/{id}
Read a research back
const = await ..("get", "/v1/shop/agent/research/{id}", {
: {
: "research_0000000000000000"
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: GET /v1/shop/agent/research/{id} in the HTTP reference.