This is a private Composer repository.
To use it, you have to add this repository to your composer.json file.
Add this Composer
repository to your project's composer.json
file, then you can require these private packages just like you would with
one from Packagist.
{
"repositories": [{
"type": "composer",
"url": "https://packages.talisman-innovations.com"
}]
}
Click on an individual package's release version to get a snippet of code for your project's dependencies.
Read more on how to handle composer private packages.
Root repository cannot be installed with composer. Use subpackages like async-aws/s3
This is a Symfony 3.2/4.0/5.0 Bundle helps you to read and write Spreadsheet files (including pdf, xls, xlsx, odt, csv), thanks to the PHPSpreadsheet library
A php library which implements the complete functionality of the Campaign Monitor API.
A Salesforce API mapper
A bundle that provides a simple /healthcheck route
Module campaignmonitor for Magento2
PHP version of mysqldump cli that comes with MySQL
PHP client for Amazon's Selling Partner API
PHP 5.3+ oAuth 1/2 Library
List of world countries in JSON, CSV, XML and Yaml
eBay OAuth 2.0 Client Provider for The PHP League OAuth2-Client
PHP SDK for Shopify API
Common library for the PhpForce Salesforce libraries
A PHP client for the Salesforce SOAP API
The Official PHP SDK for QuickBooks Online Accounting API
Wrapper package for interacting with VIA's SOAP API from a php application.
Amazon Selling Partner API libs
Amazon MWS library
BigCommerce API libs
Cin7 Core Inventory API is part of Cin7 Core Inventory web application at https://inventory.dearsystems.com. https://dearinventory.docs.apiary.io/#introduction/api-introduction
Our new API allows partners to build significantly better integrations with the EKM platform. To try out the below endpoints, or for full up to date representations of the request / response models, please see the [swagger page](https://api.ekm.net/swagger/index.html). (We display examples here, but the swagger page is guaranteed to show the complete model.) To keep up to date with the latest updates, please see our [RSS feed](https://partners.ekm.net/ChangeLog/Feed) or the [partner dashboard](https://partners.ekm.net/).
Epos Now library
<div class="wt-text-body-01"><p class="wt-pt-xs-2 wt-pb-xs-2">Etsy's Open API provides a simple RESTful interface for various Etsy.com features. The API endpoints are meant to replace Etsy's Open API v2, which is scheduled to end service in 2022.</p><p class="wt-pb-xs-2">All of the endpoints are callable and the majority of the API endpoints are now in a beta phase. This means we do not expect to make any breaking changes before our general release. A handful of endpoints are currently interface stubs (labeled “Feedback Only”) and returns a "501 Not Implemented" response code when called.</p><p class="wt-pb-xs-2">If you'd like to report an issue or provide feedback on the API design, <a target="_blank" class="wt-text-link wt-p-xs-0" href="https://github.com/etsy/open-api/discussions">please add an issue in Github</a>.</p></div>© 2021-2023 Etsy, Inc. All Rights Reserved. Use of this code is subject to Etsy's <a class='wt-text-link wt-p-xs-0' target='_blank' href='https://www.etsy.com/legal/api'>API Developer Terms of Use</a>.
Eurostop Library
Eurostop Bundle
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
The Faire External API allows brands and integration partners to programmatically access and manage their data on Faire, including products, orders, inventory, and more. ## Authentication OAuth 2.0 is the recommended authorization method for accessing the Faire External API, especially for integration partners working with multiple brands. OAuth uses an Authorization Code Grant flow that allows applications to obtain an access token on behalf of a Faire user without requiring them to share credentials. To use OAuth, you'll need to: 1. Register your application in the Faire Developer Portal to get an applicationId and applicationSecret 2. Redirect users to Faire's authorization page to grant specific permissions (scopes) 3. Exchange the authorization code for an OAuth access token 4. Include both X-FAIRE-APP-CREDENTIALS (Base64-encoded applicationId:applicationSecret) and X-FAIRE-OAUTH-ACCESS-TOKEN headers in API requests --- # Key Definitions ### Product Definition A **product** is a category of similar physical items that are differentiated by their **options**. An example product could be a Faire-branded sweatshirt. The sweatshirt may come in different sizes and colors. The **product** itself represents the kind of **product**, but not a specific **variant**. ### Option Definition An **option** is a variable attribute that a **product** has. An example might be size or color. **Options** are defined with an **option name** and several **option values**. A "color" **option** could have "red", "blue", and "yellow", for example. In this example, the **option name** is "color" and the **option values** are "red", "blue", and "yellow". ### Variant Definition A **variant** is a specific combination of **option values**. For example, for a Faire-branded sweatshirt **product** with "size" and "color" options, a large, red Faire-branded sweatshirt would be a **variant**. Variants represent an actual physical item and have pricing, unique skus, and inventory. --- # Using OAuth OAuth is the recommended authorization process for accessing Faire's External API. However, if you are a single brand seeking access to Faire's APIs, we suggest generating the access token yourself in the Brand Portal. For integration partners with multiple brands, we recommend utilizing OAuth for authorization. # OAuth _OAuth_ (in this case OAuth 2.0) which stands for “Open Authorization”, is a standard designed to allow a website or application to access resources hosted by other web apps on behalf of a user. The Faire OAuth API lets applications request and obtain permissions from a Faire account to make API calls on behalf of that account. By using OAuth, applications are able to receive an access token without relying on the Faire user to provide it to them. ## Authorization Code Faire uses an ["Authorization Code Grant"](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/) flow where external partner applications obtain an authorization code that is then redeemed to get an access token. This token can then be used for authorization when calling Faire APIs. To start the flow, navigate the Faire user to the OAuth authorization page. On this page, the user is able to view a list of permissions that your application is trying to obtain. If the user decides to authorize the application, an authorization code is returned. If the user does not authorize the application, the user is redirected back to your website. ### OAuth permission URL To access the authorization page, the user needs to be redirected to a URL of the following format: `https://faire.com/oauth2/authorize?applicationId={YOUR_APP_ID}&scope=SPECIFIC_PERMISSION&state=82201dd8d83d23cc8a48caf52&redirectUrl=https://example.com.` ### Query String Parameters All the required parameters are provided in the form of a query string. Below, you can find a detailed description of all the parameters that you need to build the OAuth permission URL: | Field | Description | Required | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `applicationId`<br>string | The identifier that is assigned to your application. You can find it in the Developer Portal. | Yes | | `scope`<br>string[] | A list of the permissions that your application requests. For more information on permissions, refer to the section below. | Yes | | `state`<br>string | This parameter serves as a [CSRF](https://developer.mozilla.org/en-US/docs/Glossary/CSRF) protection mechanism. When the user gets redirected back, you can verify that the state value matches what it was set originally. | Yes | | `redirectUrl`<br>string | This is the URL to which the Faire user will be redirected to after the authorization is complete. | Yes | ### Permissions Applications must provide a list of specific permissions that they want to access from Faire user. Below you can find the list of different permissions that you can specify: | State | Description | | ------------------- | --------------------------------------------- | | `READ_PRODUCTS` | Fetch product information. | | `WRITE_PRODUCTS` | Add, update, or delete product information. | | `READ_ORDERS` | Fetch order information. | | `WRITE_ORDERS` | Add, update, or delete order information. | | `READ_BRAND` | Fetch brand information. | | `READ_RETAILER` | Fetch retailer information. | | `READ_INVENTORIES` | Fetch inventory information. | | `WRITE_INVENTORIES` | Add, update, or delete inventory information. | | `READ_SHIPMENTS` | Fetch shipments information. | | `READ_REVIEWS` | Fetch product review information. | ### Response Once the Faire user authorizes the application, the _authorizationCode_ and _state_ are passed in as query parameters in the provided _redirectUrl_. **_Keep in mind that the _**authorization code expires within 10 minutes**_. If you do not exchange it for the token within the allotted time, you will need to start the flow over again._** ## Access Token As mentioned above, once you receive an authorization code you can exchange it for an OAuth access token. Use the access token to make authorized requests on behalf of the Faire user. > Sample request: ```json { "application_token": "YOUR_APP_ID", "application_secret": "YOUR_APP_SECRET", "redirect_url": "YOUR_REDIRECT_URL", "scope": ["PERMISSION_1", "PERMISSION_2"], "grant_type": "AUTHORIZATION_CODE", "authorization_code": "YOUR_CODE" } ``` ### HTTP Request `POST https://www.faire.com/api/external-api-oauth2/token` ### Request Parameters | Field | Description | Required | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `applicationId` | The identifier that is assigned to your application. You can access it in the Developer Portal. | Yes | | `applicationSecret` | The secret identifier that is assigned to your application. You can access it in the Developer Portal. **Please make sure to keep this data private and do not share it with other parties**. | Yes | | `scope` | A list of the permissions that your application requests. _This list must match the previously provided scope parameter_. | Yes | | `grantType` | The grant identifier. In this iteration of OAuth, you would need to set it to _AUTHORIZATION_CODE_. | Yes | | `redirectUrl` | This is the URL which you provided earlier. _This url must match the previously provided redirect url_. | Yes | | `authorizationCode` | This is the authorization code which you were able to receive earlier. | Yes | ### Response > Sample response ```json { "access_token": "OAUTH_ACCESS_TOKEN", "token_type": "BEARER" } ``` ## Using OAuth Access Token A major difference between OAuth tokens and the access tokens used for V1 and V2 of the Faire External Api is that _OAuth access tokens are used only for authorization, not authentication_. In order to make requests you would need to use the following headers: | Header | Description | Required | | ---------------------------- | ------------------------------------------------------------------- | -------- | | `X-FAIRE-APP-CREDENTIALS` | The _applicationId:applicationSecret_ encoded in the Base64 format. | Yes | | `X-FAIRE-OAUTH-ACCESS-TOKEN` | The OAuth access token. | Yes | Only by using these two headers together, you are able to make requests and access resources at Faire. **_Please note that OAuth is only enabled for External Api V2+ - you cannot send External V1 requests using OAuth access tokens._** ## Revoking OAuth Access Token If by any chance you lose any confidential information about the application, you can easily revoke the OAuth access token to prevent it from being used by some other party. To do this you can make the POST request to the following endpoint **\revoke** > Sample request: ```json { "application_token": "YOUR_APP_ID", "application_secret": "YOUR_APP_SECRET", "access_token_o_auth": "YOUR_TOKEN" } ``` ### HTTP Request `POST https://www.faire.com/api/external-api-oauth2/revoke` ### Request Parameters | Field | Description | Required | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `applicationToken` | The identifier that is assigned to your application. You can access it in the Developer Portal. | Yes | | `applicationSecret` | The secret identifier that is assigned to your application. You can access it in the Developer Portal. **Please make sure to keep this data private and do not share it with other parties**. | Yes | | `accessTokenOAuth` | This is the OAuth token that you want to get revoked. | Yes | ### Response > Sample response ```json { "success": "true" } ``` --- # Idempotency An idempotent operation can be applied multiple times without changing the result. Many of Faire's APIs have a mechanism to allow for idempotent operations. Imagine you are trying to create a product and then the network connection fails after we create the product in Faire, but before we can return the results to you. You see it as a failure and might try to create the product again. Without idempotent operations, there are now 2 duplicate products in Faire! The Faire APIs require an `idempotency_token` when creating new objects in our system. This token can be any string of characters and should be unique to the object you are creating. With the idempotency token, you can retry failed requests without risk of duplicating data in our system. --- # Changelog ## 2025-11 - Added [Update Product Prices by Product Variant IDs](#/paths/product-prices-by-product-variant-ids/patch) endpoint to update product variant prices in batch - Added [Update Product Prices by SKUs](#/paths/product-prices-by-skus/patch) endpoint to update product variant prices by SKU in batch - Added `has_pending_retailer_cancellation_request` to [orders](#/schemas/ExternalOrderV2) - Added `shipping_label_url` to [shipments](#/schemas/ExternalShipmentV2) - Added [View Packing Slip PDF](#/paths/orders-order_id--packing-slip-pdf/get) endpoint to retrieve PDF packing slips for brand orders - Added `made_in_country` to [products](#/schemas/ExternalProductV2) - Added `case_measurements` to [product variants](#/schemas/ExternalProductVariantV2) ## 2025-10 - Added `original_order_id` query parameter to filter orders by original order ID in the [Get all Orders](#/paths/orders/get) endpoint - Added `notes` to [orders](#/schemas/ExternalOrderV2) - Added `is_insider` to [retailers](#/schemas/GetExternalRetailerProfileResponseV2) ## 2025-09 - Added `purchase_order_number` to [orders](#/schemas/ExternalOrderV2) ## 2025-06 - Added `estimated_payout_at` to [orders](#/schemas/ExternalOrderV2) ## 2024-11 - Added `is_free_shipping`, `free_shipping_reason` and `faire_covered_shipping_cost` to [orders](#/schemas/ExternalOrderV2) - Added `shipping_type` to [shipments](#/schemas/ExternalShipmentV2) ## 2024-09 - Added `total_brand_discounts` and `subtotal_after_brand_discounts` to [payout costs](#/schemas/ExternalPayoutCostsV2) ## 2024-05 - Add `address_type` field to [addresses](#/schemas/ExternalAddressV2) ## 2024-03 - Added new page for new [product variant inventory](#/schemas/ExternalProductVariantInventory) endpoints and deprecated old endpoints ## 2023-06 - Added `payout_flat_fee` and `commission_flat_fee`, updated `payout_fee` and `commission` to [payout costs](#/schemas/ExternalPayoutCostsV2) ## 2023-05 - Added OAuth flow documentation including how to create authorization codes, create access tokens and revoke access tokens. - Added support for cursor pagination on [get all orders](#/paths/orders/get) and [get all products](#/paths/products/get) endpoints ## 2023-04 - Added endpoints for [removing an image from a product](#/paths/products-product_id--images--image_id/delete) and [removing an image from a variant](#/paths/products-product_id--variants--variant_id--images--image_id/delete). ## 2023-03 - Documented the `PENDING_RETAILER_CONFIRMATION` state for [orders](#/schemas/ExternalOrderV2.State) and [order items](#/schemas/ExternalOrderItemV2.State). Orders in this state are now returned from the [Get all Orders](#/paths/orders/get) endpoint. - Added support for creating [prepacks](#/schemas/ExternalPrepackV2) in batches using the [Add Multiple Prepacks to a Product](#/paths/products-product_id--prepacks-batch/post) endpoint. - Added documentation for canceling an [order](#/schemas/ExternalOrderV2) using the [Cancel an Order](#/paths/orders-order_id--cancel/put) endpoint. - Added support for [uploading images](#/paths/products-upload-image/post) to be used by products/variants. ## 2023-02 - Added `state` field to [order items](#/schemas/ExternalOrderItemV2) and [documented the possible states](#/schemas/ExternalOrderItemV2.State). - Added support for measurements for product variants. ## 2023-01 - Added several fields to [payout costs](#/schemas/ExternalPayoutCostsV2) ## 2022-11 - Added `brand_discounts` field to [orders](#/schemas/ExternalOrderV2) and `discounts` to [order items](#/schemas/ExternalOrderItemV2) ## 2022-10-14 - Update product variant pricing geo constraint `country` and `country_group` restraints ## 2021-04-26 - Added support for open pack [products](#/schemas/ExternalProductV2) via `per_style_minimum_order_quantity` ## 2021-04-14 - Added support for geographic pricing for product variants. - Deprecated `retailer_price_cents` and `wholesale_price_cents` ## 2021-04-07 - Adjusted the maximum length of product short_description and description to match with brand portal ## 2021-03-17 - Fixed incorrect `unit_multiplier` and `minimum_order_quantity` values in sample requests and responses under [product](#/schemas/ExternalProductV2) endpoints - Added missing request parameter `minimum_order_quantity` to create and patch [product](#/schemas/ExternalProductV2) endpoints ## 2021-03-15 - Added preorder details in create and patch [product](#/schemas/ExternalProductV2) endpoints ## 2021-03-10 - We noticed [prepacks](#/schemas/ExternalPrepackV2) shouldn't have any images, and we removed the field `image` from all requests and responses under that section. ## 2021-03-01 - External API V2 was released
ICRTouch library
Lightspeed Library
API for Lightspeed Retail POS system. This specification covers the R-Series API endpoints. NOTE: This is an abridged version of the R-Series API Documentation. For more detailed documentation, visit [API Developer Documentation](https://developers.lightspeedhq.com/retail/)
Lightspeed Bundle
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Opsuite Library
<p>Welcome the the OpSuite.API. This swagger page is the best place to familiarize yourself with the API before you write any client code. </p<p>Here is some general information about the use of the API.<p><p><b>Authentication</b><p>All requests require authentication. You will need a username and password in order to obtain a bearer token that is then used with all requests. If you do not have a username and password then contact the enterprise you are developing for.</p><p><b>Rate Limits</b><p><p>OpSuite.API is limited on a per client basis.<p><p>In order for your client to be allocated the correct rate limits you should add a header to your request with a Key of X-ClientId and a Value of your username.<p><p>You should then contact us so we can setup your rate limits.<p><p>If you do not set the X-ClientId header then your requests will be limited by a default set of low rates limits.<p><p>It is important that you use the API in the most efficient way so that you do not reach the rate limits.<p><p>Requests exceeding the limit will return a '429 Too Many Requests' along with a JSON error message.<p><p>A client's limits and usage are reported with every API request as part of the HTTP Headers.<p><p>Example successful response headers:<p><p>HTTP/1.1 200 OK<br>X-Rate-Limit: 24h<br>X-Rate-Limit-Remaining: 249963<br>X-Rate-Limit-Reset: 2022-11-25T09:20:41<p><p>Example rate-limited response JSON error message and headers:<p><p>Content: API calls quota exceeded! maximum admitted 4500 per 15m.<br>HTTP/1.1 429 Too many Requests<br>Retry-After: 10 (seconds)<p>
https://devdocs.prestashop-project.org/8/webservice/
Quickbooks library
Red61 Bundle
A client implementation of Revels APIs
Revel Bundle
Documentation of the Sage Business Cloud Accounting API.
PHP 8.4 library for Salesforce REST API with extensible model support
Shopify library
A client implementation of the SkuVault API
Skuvault Bundle
SmartVolution library
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Comprehensive API collection for Temu marketplace operations including product management, order processing, inventory management, pricing, and fulfillment services. All endpoints use POST method with operation type specified in request body. Authentication uses MD5 signature with app_key, app_secret, access_token, and timestamp.
See https://partner.tiktokshop.com/docv2/page/656559fcf4488c02dfe8ce82 TikTok Shop provides a comprehensive range of APIs known as TTS API, which allows TTS developers access to user data within the app, including catalogs, orders, shipments, payments, and more. Leveraging the capabilities of the TTS API, developers can create apps that extend Seller Center's existing functionalities. These apps can enhance product catalog listings, streamline order fulfillment, minimize operational burdens, and accelerate customer interactions
Unleashed API library
Visualsoft Library
Woocommerce v3.0 API See https://woocommerce.github.io/woocommerce-rest-api-docs/#introduction
Xero API https://developer.xero.com
Abandoned! Package is abandoned, you should avoid using it. No replacement was suggested.
Simple CLI utility for generating php classes from a wsdl file.
This Composer repository is powered by Satis