### Get Platform Cargo Profile List (API Example) Source: https://developer.idefix.com/api/urun-entegrasyonu/kargo-profil-listesi Bu kod parçacığı, platformda tanımlı kargo profillerinin listesini almak için kullanılan API isteğinin örnek yanıtını göstermektedir. Yanıt, her bir kargo profili için ID, başlık, vergi numarası ve çeşitli destek durumları gibi detayları içerir. Bu veriler, entegrasyonlarda kargo şirketlerini belirlemek için kullanılır. ```json [ { "title": null, "cargoCompany": { "id": 45, "title": "Demo Kargo", "code": "Demo", "taxNumber": "1234567891" }, "status": true, "cargoIntegrationUrl": "test", "cargoTrackingUrl": "test", "cargoUserCredential": [ "Demo kargo" ], "isPlatformTrackingSupport": false, "isSellerTrackingSupport": false, "isPlatformAgreementSupport": false, "isSellerAgreementSupport": true, "isPlatformCargoSend": false, "isSellerCargoSend": false, "acceptReturn": false, "fullCoverage": true, "acceptHomeReturn": false }, { "title": null, "cargoCompany": { "id": 45, "title": "Demo Kargo", "code": "Demo", "taxNumber": "1234567891" }, "status": true, "cargoIntegrationUrl": "sss.com.tr", "cargoTrackingUrl": "sssddd.com.tr", "cargoUserCredential": [ "Demo kargo" ], "isPlatformTrackingSupport": false, "isSellerTrackingSupport": false, "isPlatformAgreementSupport": false, "isSellerAgreementSupport": true, "isPlatformCargoSend": false, "isSellerCargoSend": false, "acceptReturn": false, "fullCoverage": true, "acceptHomeReturn": false } ] ``` -------------------------------- ### Example idefix API Service Response (JSON) Source: https://developer.idefix.com/api/siparis-entegrasyonu/iade-listesi This is an example JSON response from the idefix API, illustrating the structure of returned data for customer orders. It includes details about total counts, items, and individual order item information, such as product details, pricing, and return reasons. ```json { "totalCount": 2, "itemCount": 2, "pageCount": 1, "currentPage": 1, "limit": 50, "items": [ { "customerId": 104710723, "customerName": "Derya Kaya", "vendorTitle": "idefix", "createdAt": "2023-05-17T18:56:29+03:00", "orderCreatedAt": "2023-05-03T16:04:12+03:00", "orderNumber": "IDE64525bcc2d1c6", "id": 241, "cargoTrackingUrl": null, "cargoTrackingNumber": null, "cargoKey": "CLMY241", "cargoCompanyId": 74, "cargoCompanyName": "Yurtiçi Kargo", "cargoProfileId": 1, "cargoProfileName": "Yurtiçi Kargo Platform Öder", "cargoTypeId": 3, "cargoTypeName": "return", "items": [ { "productPrice": 10.05, "vendorPrice": 10.05, "discountedTotalPrice": 10.05, "platformDiscount": 0, "vendorDiscount": 0, "totalDiscount": null, "interestPrice": 0, "vat": 0, "totalPrice": 10.05, "productName": "Tezus", "productImage": "https://static.idefix.net/resize/{size}product/263195/tezus-64372d7596f8c.jpg", "productCode": "IDE-1681337716963", "barcode": "9786057903372", "erpId": "1819603001", "slug": "tezus-p-263195", "note": null, "customerNote": null, "vendorNote": "müşteri ürünü fazla göndermiş", "platformReason": null, "platformReasonId": null, "vendorReason": "Teslim edilemeyen gönderi", "vendorReasonId": 3015, "customerReason": null, "customerReasonId": null, "stateUpdatedAt": "2023-05-17T18:57:22+03:00", "declineRequestNote": null, "declineRequestReasonName": null, "state": "approved", "stateName": "İade onaylandı", "orderLineId": 10000375, "id": 262, "autoApproveDate": "2023-05-19T23:59:59+03:00", "isAutoApprove": false, "approvedAt": "2023-05-17T18:57:22+03:00", "isControversial": false } ] }, { "customerId": 104710723, "customerName": "Derya Kaya", "vendorTitle": "idefix", "createdAt": "2023-05-16T09:39:26+03:00", "orderCreatedAt": "2023-05-03T16:04:12+03:00", "orderNumber": "IDE64525bcc2d1c6", "id": 232, "cargoTrackingUrl": "https://www.yurticikargo.com/tr/online-servisler/gonderi-sorgula?code=91687272748", "cargoTrackingNumber": "916872729748", "cargoKey": "CLMY232", "cargoCompanyId": 74, "cargoCompanyName": "Yurtiçi Kargo", "cargoProfileId": 1, "cargoProfileName": "Yurtiçi Kargo Platform Öder", "cargoTypeId": 3, "cargoTypeName": "return", "items": [ { "productPrice": 10.9, "vendorPrice": 10.9, "discountedTotalPrice": 10.9, "platformDiscount": 0, "vendorDiscount": 0, "totalDiscount": null, "interestPrice": 0, "vat": 0, "totalPrice": 10.9, "productName": "Köy Hayatından Sahneler", "productImage": "https://static.idefix.net/resize/{size}product/214882/koy-hayatindan-sahneler-6436b3c3a468e.jpg", "productCode": "IDE-1681306562203", "barcode": "9786050923131", "erpId": "1582829001", "slug": "koy-hayatindan-sahneler-p-214882", "note": null, "customerNote": null, "vendorNote": null, "platformReason": null, "platformReasonId": null, "vendorReason": null, "vendorReasonId": null, "customerReason": "Modelini beğenmedim", "customerReasonId": 6251, "stateUpdatedAt": "2023-05-17T17:05:42+03:00", "declineRequestNote": null, "declineRequestReasonName": null, "state": "approved", "stateName": "İade onaylandı", "orderLineId": 10000376, "id": 252 } ] } ] } ``` -------------------------------- ### Example POST Request for Inventory Upload Source: https://developer.idefix.com/api/urun-entegrasyonu/stok-ve-fiyat-gonderim This is an example JSON payload for the POST inventory-upload request. It includes a list of items, each with details like barcode, price, inventory quantity, and delivery information. Ensure all required fields are populated correctly. ```json { "items": [ { "barcode": "string", "price": 3000, "comparePrice": 3000, "inventoryQuantity": 0, "maximumPurchasableQuantity": 0, "deliveryDuration": 1, "deliveryType": "regular", "isZoneSale": null } ] } ``` -------------------------------- ### GET /claim-list Source: https://developer.idefix.com/api/siparis-entegrasyonu/iade-listesi İdefix sisteminde iade talebi oluşan shipment'ları çekmek için kullanılır. Vendor ID zorunludur. ```APIDOC ## GET /claim-list ### Description İdefix sisteminde iade talebi oluşan shipment'ları çekmek için kullanılır. Vendor ID zorunludur. ### Method GET ### Endpoint https://merchantapi.idefix.com/oms/{vendorId}/claim-list ### Parameters #### Path Parameters - **vendorId** (string) - Zorunlu - Her satıcının benzersiz bir tanımlayıcısıdır. #### Query Parameters - **ids** (string) - İsteğe Bağlı - Tekil olarak ilgili iadenin detayını çekmek için claim ID ile istek atılabilir. - **orderNumber** (string) - İsteğe Bağlı - Shipment'ın İdefix sistemindeki ana sipariş numarasına karşılık gelir. - **claimReason** (string) - İsteğe Bağlı - İlgili reason ID'ye göre oluşturulmuş claim'leri listelemek için kullanılır. - **startDate** (string) - İsteğe Bağlı - Belirli bir tarihten sonraki iadeler için sorgulama yapılabilir. Örnek Format : 2022/09/30 23:59:59 - **endDate** (string) - İsteğe Bağlı - Belirtilen tarihe kadar olan iadeler için sorgulama yapılabilir. Örnek Format : 2022/09/30 23:59:59 - **lastUpdatedAt** (string) - İsteğe Bağlı - İadenin durumunun son güncellenme tarihini baz alır. Örnek Format : 2022/09/30 23:59:59 ### Request Example ``` GET https://merchantapi.idefix.com/oms/12345/claim-list?orderNumber=ORD98765&startDate=2023/01/01 00:00:00 ``` ### Response #### Success Response (200) - **claims** (array) - İade taleplerinin listesi. - **claimId** (string) - İade talebinin benzersiz kimliği. - **orderNumber** (string) - İlgili sipariş numarası. - **claimReason** (string) - İade nedeni. - **claimStatus** (string) - İade durumu. - **createdAt** (string) - İade talebinin oluşturulma tarihi. - **updatedAt** (string) - İade talebinin son güncellenme tarihi. #### Response Example ```json { "claims": [ { "claimId": "CLM123", "orderNumber": "ORD98765", "claimReason": "Defective Product", "claimStatus": "Pending", "createdAt": "2023/10/27 10:00:00", "updatedAt": "2023/10/27 10:00:00" } ] } ``` ``` -------------------------------- ### Example POST Response for Inventory Upload Source: https://developer.idefix.com/api/urun-entegrasyonu/stok-ve-fiyat-gonderim This is an example JSON response from the inventory-upload service. It indicates the status of the uploaded items and provides timestamps for creation, completion, and last update. The batchRequestId is crucial for tracking the operation's status. ```json { "items": [ { "barcode": "8806088712239", "price": 30, "comparePrice": 50, "inventoryQuantity": 50, "maximumPurchasableQuantity": 0, "deliveryDuration": 1, "deliveryType": "regular", "isZoneSale": null, "status": "completed" } ], "lastUpdatedAt": "2022-10-20T10:25:01+03:00", "completedAt": "2022-10-20T10:25:01+03:00", "createdAt": "2022-10-20T10:25:01+03:00", "status": "FAILED", "batchRequestId": "101b-6350f7cdc8449" } ``` -------------------------------- ### List Products via Idefix API (GET Request) Source: https://developer.idefix.com/api/urun-entegrasyonu/urunlerim-listesi This snippet demonstrates how to retrieve a list of products from the Idefix marketplace using a GET request. It requires the vendor's unique ID and supports optional parameters for pagination (page, limit) and filtering by barcode. Ensure pagination is used for comprehensive data retrieval. ```HTTP GET https://merchantapi.idefix.com/pim/pool/{vendorId}/list?page=1&limit=10&barcode=8879615313500 ``` -------------------------------- ### GET /pim/pool/{vendorId}/list - Product Listing Source: https://developer.idefix.com/api/urun-entegrasyonu/urunlerim-listesi Retrieves a list of all products associated with a specific vendor. Pagination is mandatory for fetching all product information. ```APIDOC ## GET /pim/pool/{vendorId}/list ### Description Retrieves a list of all products associated with a specific vendor. Pagination is mandatory for fetching all product information. ### Method GET ### Endpoint https://merchantapi.idefix.com/pim/pool/{vendorId}/list ### Parameters #### Path Parameters - **vendorId** (string) - Required - The unique identifier for the vendor. #### Query Parameters - **page** (integer) - Optional - Specifies the page number of products to retrieve. - **limit** (integer) - Optional - Specifies the number of products to return per page. - **barcode** (string) - Optional - Allows filtering products by barcode. ### Response #### Success Response (200) - **products** (array) - A list of product objects. - **barcode** (string) - The barcode of the product. - **title** (string) - The title of the product. - **productMainId** (string) - The main ID of the product. - **brandId** (integer) - The ID of the product's brand. - **categoryId** (integer) - The ID of the product's category. - **inventoryQuantity** (integer) - The current stock quantity. - **vendorStockCode** (string) - The vendor's stock code for the product. - **weight** (string) - The weight of the product. - **description** (string) - The description of the product. - **price** (number) - The price of the product. - **comparePrice** (number) - The comparison price of the product. - **vatRate** (number or null) - The VAT rate for the product. - **deliveryDuration** (integer) - The estimated delivery duration in days. - **deliveryType** (string) - The type of delivery. - **cargoCompanyId** (integer or null) - The ID of the cargo company. - **shipmentAddressId** (integer or null) - The ID of the shipment address. - **returnAddressId** (integer or null) - The ID of the return address. - **images** (array) - A list of image objects for the product. - **url** (string) - The URL of the product image. - **attributes** (array) - A list of attribute objects for the product. - **attributeId** (integer) - The ID of the attribute. - **attributeValueId** (integer) - The ID of the attribute value. - **customAttributeValue** (string or null) - The custom value of the attribute. - **status** (string) - The current status of the product listing. - **statusDateCreatedAt** (string) - The date and time the status was created. - **reference** (integer) - A reference number for the product. - **failureReasons** (array or null) - Reasons for listing failure, if any. - **matchedProduct** (object or null) - Information about a matched product, if available. - **needAutoMatch** (boolean) - Indicates if the product needs automatic matching. - **addType** (string) - The type of addition for the product. - **erpId** (string or null) - The ERP ID of the product. - **authorId** (string or null) - The ID of the author who added the product. #### Response Example ```json { "products": [ { "barcode": "8879615313500", "title": "MATTEL Barbie Bebek Bakıcılığı Oyun Seti Esmer Bebek - Yeşil Biberon", "productMainId": "FHY777", "brandId": 68699, "categoryId": 110665444, "inventoryQuantity": 52, "vendorStockCode": "FHY77YSL", "weight": "195", "description": "MATTEL Barbie Bebek Bakıcılığı Oyun Seti Esmer Bebek - Yeşil Biberon", "price": 149, "comparePrice": 159, "vatRate": null, "deliveryDuration": 1, "deliveryType": "regular", "cargoCompanyId": null, "shipmentAddressId": null, "returnAddressId": null, "images": [ { "url": "https://cdn.dsmcdn.com/mnresize/1200/1800/ty96/product/media/images/20210404/22/57317cde/59506322/1/1_org_zoom.jpg" } ], "attributes": [ { "attributeId": 7, "attributeValueId": 103400, "customAttributeValue": null }, { "attributeId": 1, "attributeValueId": 100130, "customAttributeValue": null } ], "status": "not_matched", "statusDateCreatedAt": "2023-02-07T11:00:23+03:00", "reference": 528, "failureReasons": null, "matchedProduct": null, "needAutoMatch": false, "addType": "integration", "erpId": null, "authorId": null } ] } ``` ``` -------------------------------- ### GET /websites/developer_idefix_api Source: https://developer.idefix.com/api/siparis-entegrasyonu/siparislerin-alinmasi Retrieves a list of orders with detailed information including customer, addresses, and item breakdown. Supports pagination and filtering. ```APIDOC ## GET /websites/developer_idefix_api ### Description Retrieves a list of orders with detailed information including customer, addresses, and item breakdown. Supports pagination and filtering. ### Method GET ### Endpoint /websites/developer_idefix_api ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. - **limit** (integer) - Optional - The number of items per page. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **totalCount** (integer) - The total number of items available. - **itemCount** (integer) - The number of items returned in the current response. - **pageCount** (integer) - The total number of pages. - **currentPage** (integer) - The current page number. - **limit** (integer) - The limit of items per page. - **items** (array) - An array of order objects. - **invoiceAddress** (object) - Details of the invoice address. - **shippingAddress** (object) - Details of the shipping address. - **id** (integer) - Unique identifier for the order. - **orderNumber** (string) - The order number. - **totalPrice** (number) - The total price of the order. - **totalDiscount** (number) - The total discount applied to the order. - **discountedTotalPrice** (number) - The total price after discount. - **totalPlatformDiscount** (number) - The total platform discount. - **totalVendorDiscount** (number) - The total vendor discount. - **customerId** (integer) - The ID of the customer. - **customerContactName** (string) - The name of the customer contact. - **customerContactMail** (string) - The email of the customer contact. - **customerTcNumber** (string) - The TC number of the customer (if applicable). - **cargoTrackingNumber** (string) - The tracking number for the cargo. - **cargoTrackingUrl** (string) - The URL for tracking the cargo. - **cargoCompany** (string) - The name of the cargo company. - **cargoTypeId** (integer) - The ID of the cargo type. - **cargoTypeName** (string) - The name of the cargo type. - **cargoProfileId** (integer) - The ID of the cargo profile. - **cargoProfileName** (string) - The name of the cargo profile. - **geoCode** (string) - Geographic code associated with the order. - **createdAt** (string) - The date and time the order was created. - **updatedAt** (string) - The date and time the order was last updated. - **orderDate** (string) - The date and time the order was placed. - **histories** (array) - An array of order history objects. - **state** (string) - The state of the order history item. - **createdAt** (string) - The date and time of the history item. - **status** (string) - The current status of the order. - **statusUpdatedAt** (string) - The date and time the status was last updated. - **deliveryType** (string) - The type of delivery. - **estimatedDeliveryDate** (string) - The estimated delivery date. - **vendorTitle** (string) - The title of the vendor. - **vendorId** (integer) - The ID of the vendor. - **statusDescription** (string) - A description of the order status. - **cargoKey** (string) - The cargo key. - **items** (array) - An array of item objects within the order. - **productName** (string) - The name of the product. - **id** (integer) - The unique identifier for the item. - **barcode** (string) - The barcode of the product. - **erpId** (string) - The ERP ID of the product. - **image** (string) - The URL of the product image. - **price** (number) - The price of the item. - **totalDiscount** (number) - The total discount for the item. - **platformDiscount** (number) - The platform discount for the item. - **vendorDiscount** (number) - The vendor discount for the item. - **discountedTotalPrice** (number) - The discounted total price for the item. - **currency** (string) - The currency of the price. - **itemStatus** (string) - The status of the item. - **comparePrice** (number) - The compare price of the item. - **vendorAmount** (number) - The vendor amount for the item. #### Response Example ```json { "totalCount": 1, "itemCount": 1, "pageCount": 1, "currentPage": 1, "limit": 20, "items": [ { "invoiceAddress": { "isCommercial": "", "isLikeCommercial": "", "id": 21403112, "firstName": "Derya", "lastName": "Kaya", "company": null, "address1": "Test adresidir.", "city": "İstanbul", "cityId": 34, "cityPlate": "34", "postalCode": "", "neighboorhood": "Çengelköy", "neighboorhoodId": 34000, "county": "Üsküdar", "countyId": 1708, "countryCode": "TR", "phone": "5555555555", "fullName": "Derya Kaya", "fullAddress": "Test adresidir. Çengelköy İstanbul ", "taxOffice": "", "taxNumber": "", "identificationNumber": "52369854125", "floor": "1", "buildingNumber": "29", "doorNumber": "1" }, "shippingAddress": { "isCommercial": "", "isLikeCommercial": "", "id": 21403112, "firstName": "Derya", "lastName": "Kaya", "company": null, "address1": "Test adresidir.", "city": "İstanbul", "cityId": 34, "cityPlate": "34", "postalCode": "", "neighboorhood": "Çengelköy", "neighboorhoodId": 34000, "county": "Üsküdar", "countyId": 1708, "countryCode": "TR", "phone": "5555555555", "fullName": "Derya Kaya", "fullAddress": "Test adresidir.Çengelköy İstanbul ", "taxOffice": "", "taxNumber": "", "identificationNumber": "52369854125", "floor": "1", "buildingNumber": "29", "doorNumber": "1" }, "id": 60000003, "orderNumber": "IDE642eabe9bd3b2", "totalPrice": 54.9, "totalDiscount": 0, "discountedTotalPrice": 54.9, "totalPlatformDiscount": 0, "totalVendorDiscount": 0, "customerId": 104710723, "customerContactName": "Derya Kaya", "customerContactMail": "1000019@idefixcustomer.com", "customerTcNumber": null, "cargoTrackingNumber": "11111", "cargoTrackingUrl": "aaa.com", "cargoCompany": "Yurtiçi Kargo", "cargoTypeId": 1, "cargoTypeName": "delivery", "cargoProfileId": 3, "cargoProfileName": "Yurtiçi Kargo Satıcı Öder", "geoCode": null, "createdAt": "2023-04-06T14:27:52+03:00", "updatedAt": "2023-04-07T17:23:56+03:00", "orderDate": "2023-04-06T11:24:25+03:00", "histories": [ { "state": "created", "createdAt": "2023-04-06T14:27:52+03:00" }, { "state": "shipment_ready", "createdAt": "2023-04-06T14:27:52+03:00" }, { "state": "shipment_in_cargo", "createdAt": "2023-04-07T17:23:56+03:00" }, { "state": "shipment_picking", "createdAt": "2023-04-07T14:02:56+03:00" }, { "state": "shipment_invoiced", "createdAt": "2023-04-07T14:04:09+03:00" } ], "status": "shipment_in_cargo", "statusUpdatedAt": "2023-04-07T17:23:56+03:00", "deliveryType": "regular", "estimatedDeliveryDate": "2023-04-07T15:00:59+03:00", "vendorTitle": "idefix", "vendorId": 3, "statusDescription": "Kargoya Verildi", "cargoKey": null, "items": [ { "productName": "İnsanın Anlam Arayışı", "id": 10000043, "barcode": "9786054054206", "erpId": "1284814001", "image": "https://static.idefix.net/resize/{size}product/26388/insanin-anlam-arayisi-642e3f0068526.jpg", "price": 54.9, "totalDiscount": null, "platformDiscount": 0, "vendorDiscount": 0, "discountedTotalPrice": 54.9, "currency": "TL", "itemStatus": "in_delivery", "comparePrice": 0, "vendorAmount": 54.9 } ] } ] } ``` ``` -------------------------------- ### GET /profile/list Source: https://developer.idefix.com/api/urun-entegrasyonu/kargo-profil-listesi Platformda tanımlı bulunan kargo profil bilgilerine ait ID değerleri bu servis kullanılarak alınacaktır. ```APIDOC ## GET /profile/list ### Description Bu servis, platformda tanımlı bulunan kargo profil bilgilerine ait ID değerlerini döndürür. ### Method GET ### Endpoint /profile/list ### Parameters #### Query Parameters Bu endpoint herhangi bir query parametresi kabul etmez. #### Request Body Bu endpoint herhangi bir request body kabul etmez. ### Request Example Bu endpoint için örnek bir request bulunmamaktadır. ### Response #### Success Response (200) Bu endpoint, bir dizi kargo profil nesnesi döndürür. Her nesne aşağıdaki alanları içerir: - **title** (string) - Profil başlığı (null olabilir). - **cargoCompany** (object) - Kargo şirketi bilgileri: - **id** (integer) - Kargo şirketi ID'si. - **title** (string) - Kargo şirketi adı. - **code** (string) - Kargo şirketi kodu. - **taxNumber** (string) - Kargo şirketi vergi numarası. - **status** (boolean) - Profilin aktif olup olmadığını belirtir. - **cargoIntegrationUrl** (string) - Kargo entegrasyon URL'si. - **cargoTrackingUrl** (string) - Kargo takip URL'si. - **cargoUserCredential** (array of strings) - Kargo kullanıcı kimlik bilgileri. - **isPlatformTrackingSupport** (boolean) - Platformun takip desteği olup olmadığını belirtir. - **isSellerTrackingSupport** (boolean) - Satıcının takip desteği olup olmadığını belirtir. - **isPlatformAgreementSupport** (boolean) - Platform anlaşmalı olup olmadığını belirtir. - **isSellerAgreementSupport** (boolean) - Satıcı anlaşmalı olup olmadığını belirtir. - **isPlatformCargoSend** (boolean) - Platform üzerinden kargo gönderimi desteği olup olmadığını belirtir. - **isSellerCargoSend** (boolean) - Satıcı üzerinden kargo gönderimi desteği olup olmadığını belirtir. - **acceptReturn** (boolean) - İade kabul desteği olup olmadığını belirtir. - **fullCoverage** (boolean) - Tam kapsam desteği (ulusal kargo) olup olmadığını belirtir. - **acceptHomeReturn** (boolean) - Evden iade kabul desteği olup olmadığını belirtir. #### Response Example ```json [ { "title": null, "cargoCompany": { "id": 45, "title": "Demo Kargo", "code": "Demo", "taxNumber": "1234567891" }, "status": true, "cargoIntegrationUrl": "test", "cargoTrackingUrl": "test", "cargoUserCredential": [ "Demo kargo" ], "isPlatformTrackingSupport": false, "isSellerTrackingSupport": false, "isPlatformAgreementSupport": false, "isSellerAgreementSupport": true, "isPlatformCargoSend": false, "isSellerCargoSend": false, "acceptReturn": false, "fullCoverage": true, "acceptHomeReturn": false } ] ``` #### Error Response Bu endpoint için spesifik hata yanıtları belirtilmemiştir. Genel API hata yönetimi uygulanabilir. ``` -------------------------------- ### GET /pim/product-category Source: https://developer.idefix.com/api/urun-entegrasyonu/kategorilerin-alinmasi Retrieves a list of product categories. The IDs obtained from this service will be used when sending requests to the 'create' service. ```APIDOC ## GET /pim/product-category ### Description Retrieves a list of product categories. The IDs obtained from this service will be used when sending requests to the 'create' service. ### Method GET ### Endpoint https://merchantapi.idefix.com/pim/product-category ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **id** (integer) - The ID of the category in the Idefix system. - **name** (string) - The name of the category. - **parentId** (integer) - The ID of the parent category. - **subs** (array) - Subcategories of the current category. If there are no subcategories, 'subs' will be empty. - **topCategory** (integer) - The ID of the 1st level category the category belongs to. #### Response Example ```json [ { "id": 522, "parentId": 0, "subs": [ { "id": 1192, "parentId": 522, "subs": [ { "id": 545, "parentId": 1192, "subs": [], "name": "Salopet", "topCategory": 522 }, { "id": 546, "parentId": 1192, "subs": [], "name": "Tulum", "topCategory": 522 } ], "name": "Salopet & Tulum", "topCategory": 522 } ], "name": "Salopet & Tulum", "topCategory": 522 } ] ``` ``` -------------------------------- ### GET claim-reasons API İsteği Source: https://developer.idefix.com/api/siparis-entegrasyonu/iade-talep-sebep-listesi Bu örnek, Idefix Geliştirici API'sine vendor ID'ye göre iade talep nedenlerini almak için nasıl bir GET isteği gönderileceğini gösterir. İsteğin başarılı olması durumunda, iade nedenlerinin bir listesi JSON formatında dönecektir. Bu liste, 'claim-create' servisinde kullanılabilir. ```http GET https://merchantapi.idefix.com/oms/{vendorId}/claim-reasons ``` -------------------------------- ### POST /pim/pool/{vendorId}/create - Create Single Product Source: https://developer.idefix.com/api/urun-entegrasyonu/urun-olusturma This method should be used when uploading your products to the idefix MP system. Before you can transfer products with this method, you must obtain the relevant information from the idefix Brand List and Category/Category Feature information services. Otherwise, your products will not be created in the idefix system. After you retrieve the attributes before transferring products with this method, those marked as 'required True' must be sent in the product creation request. Otherwise, your products will not be created in the idefix system. After the product transfer process, you should check the status of your products and the transfer process via the 'batch-result' service with the 'batchRequestId' provided in the response. 'vendor' is the unique identifier for each seller. It is a mandatory field. ```APIDOC ## POST /pim/pool/{vendorId}/create ### Description Creates a single product listing on the Idefix platform. ### Method POST ### Endpoint `https://merchantapi.idefix.com/pim/pool/{vendorId}/create` ### Parameters #### Path Parameters - **vendorId** (string) - Required - The unique identifier for the seller. #### Query Parameters None #### Request Body - **barcode** (string) - Required - The barcode of the product. - **title** (string) - Required - The name of the product. - **productMainId** (string) - Required - The main product code. - **brandId** (string) - Required - The Idefix brand ID. You can access the service to retrieve brand information from here. - **categoryId** (string) - Required - The Idefix category ID. You can access the service to retrieve category information from here. - **inventoryQuantity** (integer) - Required - The sellable stock quantity of the product. - **vendorStockCode** (string) - Required - The seller's stock code for the product in their own system. - **desi** (number) - Optional - The dimensional weight of the package for shipping the product. - **weight** (number) - Optional - The weight of the product. - **description** (string) - Required - The description of the product. - **price** (number) - Required - The selling price of the product on Idefix. - **comparePrice** (number) - Optional - The recommended retail price of the product. - **vatRate** (number) - Required - The VAT rate of the product (e.g., 0, 1, 8, 18). - **deliveryType** (string) - Optional - Delivery type (e.g., 'regular', 'same_day_shipping'). - **cargoCompanyId** (string) - Optional - Idefix Cargo Company ID. - **shipmentAddressId** (string) - Optional - The shipment warehouse address ID in the Idefix system. - **returnAddressId** (string) - Optional - The return warehouse address ID in the Idefix system. - **images** (array) - Required - A list of URLs for product images. Image URLs must be in 'https' format with an SSL certificate. A maximum of 8 images can be added per barcode. - **url** (string) - Required - The URL of the product image. - **attributes** (array) - Required - Attribute information that can be sent for the product's category information. - **attributeId** (string) - Required - The ID of the attribute. - **originCountryId** (string) - Optional - Country of Origin information to be added when product inspection information is to be sent. - **manufacturer** (string) - Optional - Manufacturer information to be added when product inspection information is to be sent. - **importer** (string) - Optional - Importer, authorized representative, service provider information to be added when product inspection information is to be sent. - **ceCompatibility** (string) - Optional - CE Compatibility Symbol to be added when product inspection information is to be sent. - **usageInstructionsImage** (string) - Optional - Usage Instructions Image to be added when product inspection information is to be sent. - **packageFrontImage** (string) - Optional - Front Package Image to be added when product inspection information is to be sent. - **packageBackImage** (string) - Optional - Back Package Image to be added when product inspection information is to be sent. - **productInfoFormImage** (string) - Optional - Product Information Form Image to be added when product inspection information is to be sent. - **energyClassImage** (string) - Optional - Energy Class Image to be added when product inspection information is to be sent. - **energyNutritionImage** (string) - Optional - Energy and Nutrition Information Image to be added when product inspection information is to be sent. - **lotInfo** (string) - Optional - Batch/Lot/Expiry date information. ### Request Example ```json { "barcode": "1234567890123", "title": "Example Product Title", "productMainId": "PROD123", "brandId": "BRAND456", "categoryId": "CAT789", "inventoryQuantity": 100, "vendorStockCode": "VNDRSTOCK001", "desi": 2.5, "weight": 1.2, "description": "This is a detailed description of the example product.", "price": 49.99, "comparePrice": 59.99, "vatRate": 18, "deliveryType": "regular", "images": [ { "url": "https://example.com/image1.jpg" }, { "url": "https://example.com/image2.jpg" } ], "attributes": [ { "attributeId": "ATTR001", "value": "Attribute Value 1" }, { "attributeId": "ATTR002", "value": "Attribute Value 2" } ], "originCountryId": "US", "manufacturer": "Example Manufacturer", "importer": "Example Importer", "ceCompatibility": "CE", "usageInstructionsImage": "https://example.com/usage.jpg", "packageFrontImage": "https://example.com/package_front.jpg", "packageBackImage": "https://example.com/package_back.jpg", "productInfoFormImage": "https://example.com/product_info.jpg", "energyClassImage": "https://example.com/energy_class.jpg", "energyNutritionImage": "https://example.com/energy_nutrition.jpg", "lotInfo": "LOT12345" } ``` ### Response #### Success Response (200) - **batchRequestId** (string) - The ID for tracking the batch operation. #### Response Example ```json { "batchRequestId": "bth_abc123xyz789" } ``` ``` -------------------------------- ### Example Category Attribute Response Source: https://developer.idefix.com/api/urun-entegrasyonu/kategori-ozellik-listesi This is an example JSON response from the category-attribute endpoint. It lists attributes, their values, and properties like 'required', 'allowCustom', 'isVariant', and 'isSlicer'. ```json { "id": 546, "name": "Tulum", "categoryAttributes": [ { "attributeId": 24, "attributeTitle": "Dahili Hafıza", "allowCustom": false, "categoryId": 546, "required": true, "isVariant": true, "isSlicer": true, "attributeValues": [ { "id": 93301, "name": "1 TB" }, { "id": 93300, "name": "6 GB" }, { "id": 93299, "name": "1 GB" } ] } ] } ```