@teemill/warehouse-catalog
v1.63.0
Published
OpenAPI client for @teemill/warehouse-catalog
Readme
@teemill/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @teemill/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.podos.io
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CatalogApi | exportCatalog | GET /v1/warehouse/catalog/export | Export catalog CatalogApi | importCatalog | POST /v1/warehouse/catalog/import | Import catalog ProductsApi | createProduct | POST /v1/warehouse/catalog/products | Create warehouse product ProductsApi | deleteProduct | DELETE /v1/warehouse/catalog/products/{productId} | Delete warehouse product ProductsApi | getAdminProduct | GET /v1/warehouse/catalog/admin/products/{productId} | Get a warehouse product as an admin user ProductsApi | getProduct | GET /v1/warehouse/catalog/products/{productId} | Get warehouse product ProductsApi | listAdminProducts | GET /v1/warehouse/catalog/admin/products | List warehouse products as an admin user ProductsApi | listBrands | GET /v1/warehouse/catalog/products/brands | List brands ProductsApi | listProducts | GET /v1/warehouse/catalog/products | List warehouse products ProductsApi | listSuppliers | GET /v1/warehouse/catalog/products/suppliers | List warehouse products' suppliers ProductsApi | updateAdminProduct | PATCH /v1/warehouse/catalog/admin/products/{productId} | Update a warehouse product as an admin user ProductsApi | updateProduct | PATCH /v1/warehouse/catalog/products/{productId} | Update warehouse product ProductsApi | updateProducts | PATCH /v1/warehouse/catalog/products | Update warehouse products VariantsApi | getVariant | GET /v1/warehouse/catalog/variants/{variantId} | Get warehouse variant VariantsApi | listVariants | GET /v1/warehouse/catalog/variants | List warehouse variants VariantsApi | updateVariant | PATCH /v1/warehouse/catalog/variants/{variantId} | Update warehouse variant VariantsApi | updateVariants | PATCH /v1/warehouse/catalog/variants | Update warehouse variants
Documentation For Models
- AdminProduct
- AdminProductsResponse
- AgeGroup
- ApiError
- Application
- ApplicationTechnology
- Brand
- CreateProductRequest
- CreateProductRequestSupplier
- CreateProductRequestVariantsInner
- CreateProductRequestVariantsInnerApplicationsInner
- CreateProductRequestVariantsInnerManufacturerOrigin
- CreateProductRequestVariantsInnerPackedDimensions
- ExportCatalog202Response
- GenderGroup
- Image
- ImportCatalog202Response
- ListBrands200Response
- ListSuppliers200Response
- Metafield
- Mockup
- MockupDesignPlacement
- MockupDesignPlacementsInner
- Output
- OutputDeviceConfigsInner
- OutputDeviceConfigsInnerPropertiesInner
- OutputPadding
- OutputPrintProfilesInner
- Placement
- Product
- ProductAttribute
- ProductAttributeValuesInner
- ProductAttributeValuesInnerThumbnail
- ProductSupplier
- ProductType
- ProductVariantsInner
- ProductsResponse
- StockMode
- Supplier
- SustainabilityRating
- UpdateAdminProductRequest
- UpdateAdminProductRequestSuppliersInner
- UpdateProductRequest
- UpdateProductRequestPlatform
- UpdateProductRequestVariantsInner
- UpdateProductRequestVariantsInnerApplicationsInner
- UpdateProductRequestVariantsInnerManufacturerOrigin
- UpdateProductRequestVariantsInnerPackedDimensions
- UpdateProductsRequest
- UpdateProductsRequestProductsInner
- UpdateVariantRequest
- UpdateVariantRequestImagesInner
- UpdateVariantRequestPlatform
- UpdateVariantRequestPlatformApplicationsInner
- UpdateVariantsRequest
- UpdateVariantsRequestVariantsInner
- UpdateVariantsRequestVariantsInnerPlatform
- UpdateVariantsRequestVariantsInnerPlatformApplicationsInner
- Variant
- VariantAttribute
- VariantAttributeThumbnail
- VariantImage
- VariantManufacturerOrigin
- VariantPackedDimensions
- VariantPlatform
- VariantRecommendedMinimumRetailPrice
- VariantRecommendedRetailPrice
- VariantRecommendedWholesalePrice
- VariantsResponse
Documentation For Authorization
Authentication schemes defined for the API:
api-key
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
session-oauth
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A
