Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/myazarc/trendyol-api

Js Trendyol Api with Promise and Typescript support
https://github.com/myazarc/trendyol-api

javascript-library js-trendyol nodejs-trendyol trendyol-api trendyol-api-client ts-trendyol typescript-library

Last synced: 13 days ago
JSON representation

Js Trendyol Api with Promise and Typescript support

Host: GitHub
URL: https://github.com/myazarc/trendyol-api
Owner: myazarc
License: mit
Created: 2021-11-20T16:46:04.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2021-11-22T11:34:14.000Z (about 3 years ago)
Last Synced: 2024-11-20T00:34:08.674Z (about 1 month ago)
Topics: javascript-library, js-trendyol, nodejs-trendyol, trendyol-api, trendyol-api-client, ts-trendyol, typescript-library
Language: TypeScript
Homepage:
Size: 101 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # trendyol-api

[![npm version](https://badge.fury.io/js/trendyol-api.svg)](https://www.npmjs.com/package/trendyol-api)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Npm Publish workflow](https://github.com/myazarc/trendyol-api/actions/workflows/main.yml/badge.svg)

![NPM week download](https://img.shields.io/npm/dw/trendyol-api)

![jest coverage](https://raw.githubusercontent.com/myazarc/trendyol-api/main/.badges/coverage.svg)

Trendyol Api with Promise and Typescript support.

HttpClient: [axios](https://github.com/axios/axios)

# install

```bash

npm install trendyol-api --save

```

or

```bash

yarn add trendyol-api

```

# usage

```js

import Trendyol from "trendyol-api";

const ty = new Trendyol("API_KEY", "API_SECRET", "STORE_ID|MAGAZA_ID");

ty.getBrands().then((res) => {

  console.log(res.data);

});

```

```js

const trendyolApi = require("trendyol-api"),

  Trendyol = trendyolApi.Trendyol;

const ty = new Trendyol("API_KEY", "API_SECRET", "STORE_ID|MAGAZA_ID");

ty.getBrands().then((res) => {

  console.log(res.data);

});

```

# all methods

| Method                  | Description                                                                                       |

| ----------------------- | ------------------------------------------------------------------------------------------------- |

| createProduct           | Ürün göndermek için kullanılır.                                                                   |

| updatePriceAndInventory | Ürün fiyatı ve stok miktarını güncellemek için kullanılır.                                        |

| updateProduct           | Ürünün fiyat ve stok miktarı bilgisi hariç diğer bilgilerini güncellemek için kullanılır.         |

| getFilterProduct        | Kayıtlı ürünlerinizi listelemek için kullanılır.                                                  |

| getSuppliersAddresses   | İade ve Sevkiyat Adres Bilgilerini listelemek için kullanılır.                                    |

| getBatchRequestResult   | Ürün servislerinde verilern batchId sorgulaması için kullanılır.                                  |

| getOrders               | Siparişlerinizi almak için kullanılır.                                                            |

| getOrderWithAllPages    | Siparişleriniz birden fazla sayfada yer alıyorsa tamamını tek bir methodda almak için kullanılır. |

| getShipmentProviders    | Kargo Şirketlerini listemek için kullanılır.                                                      |

| getBrands               | Markaları listelemek için kullanılır.                                                             |

| getBrandsByName         | Markaları ismine göre aramak için kullanılır.                                                     |

| getCategories           | Kategorileri listelemek için kullanılır.                                                          |

| getCategoryAttributes   | Kategori-Özellik listesini almak için kullanılır.                                                 |

## Product

```js

    createProduct(payload: ProductRequest): Promise;

    updatePriceAndInventory(payload: PriceAndInventoryRequest): Promise;

    updateProduct(payload: UpdateProductRequest): Promise;

    getFilterProduct(params?: FilterProductRequest): Promise;

    getBatchRequestResult(batchRequestId: string): Promise;

```

## Order

```js

    getOrders(params?: OrderRequest): Promise;

    getOrderWithAllPages(): Promise;

```

## Other

```js

    getShipmentProviders(): Promise;

    getBrands(params?: BrandRequest): Promise;

    getBrandsByName(brandName: string): Promise;

    getCategoryAttributes(categoryId: number | string): Promise;

    getCategories(): Promise;

    getSuppliersAddresses(): Promise;

```