Skip to content

serraict/vine-floriday-python-supplier-api-client

BranchesTags

Repository files navigation

floriday-supplier-client

Every endpoint requires at least the role:app scope and the header X-Api-Key populated with your given API-key. Most endpoints also require an additional scope which is listed in their descriptions.

The current state of this version 2024v1 is Main.

  • This version will be deprecated after October 2024
  • This version will be removed after April 2025.

đź”— 2023v2: Customers API | Suppliers API đź”— 2024v1: Customers API | Suppliers API đź”— 2024v2: Customers API | Suppliers API

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2024v1
  • Package version: 0.0.4
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements

Python 3.4+, developed and tested with Python 3.12.

Installation & Usage

pip install

You can install directly from Github:

pip install git+https://github.com/serraict/vine-floriday-python-supplier-api-client

Then import the package:

import floriday_supplier_client

The package expects the authorization credentials to be provided as environment variables. See .env.example for an example.

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import floriday_supplier_client

Getting Started

Please follow the installation procedure and then run example.py

python example.py

Development

All the code in floriday_supplier_client and test are generated. Files that should not be overwritten on generation, should be included in .swagger-codegen-ignore. We maintain a single minimal working example.

swagger-codegen version     # verify you have swagger-codegen installed and available
make local_specs            # get a local copy of the swagger specification
make client                 # generate the client

To start customization, experimenting, and testing the floriday_supplier_client package:

make bootstrap
./venv/bin/activate
make update
python example.py

To make a new release, do:

make release

Documentation for API Endpoints

All URIs are relative to https://api.staging.floriday.io/suppliers-api-2024v1

Class Method HTTP request Description
AdditionalServicesApi get_additional_service_by_id GET /additional-services/{additionalServiceId} catalog:read - Returns an additional service.
AdditionalServicesApi get_additional_service_by_sequence_number GET /additional-services/sync/{sequenceNumber} catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 additional services starting from a specified sequence number.
AdditionalServicesApi get_additional_services GET /additional-services catalog:read - Returns overview of additional services.
AdditionalServicesApi get_additional_services_max_sequence GET /additional-services/current-max-sequence catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in additional services.
AuctionApi add_clock_presales_supply_line POST /clock-presales-supply-lines supply:write - Creates a new clock presales supply line.
AuctionApi add_clock_sales_from_nursery_supply_line POST /clock-sales-from-nursery/supply-lines supply:write - Creates a new clock sales from nursery supply line.
AuctionApi delete_clock_sales_from_nursery_supply_line DELETE /clock-sales-from-nursery/supply-lines/{clockSalesFromNurserySupplyLineId} supply:write - Deletes a clock sales from nursery supply line.
AuctionApi edit_clock_presales_supply_line PUT /clock-presales-supply-lines/{clockPresalesSupplyLineId} sales-order:write - Updates a clock presales supply line.
AuctionApi get_clock_presales_supply_line_by_id GET /clock-presales-supply-lines/{clockPresalesSupplyLineId} supply:read - Returns a clock presales supply line.
AuctionApi get_clock_presales_supply_lines_by_sequence_number GET /clock-presales-supply-lines/sync/{sequenceNumber} supply:read - Returns a list of max 1000 clock presales supply lines starting from a specified sequence number.
AuctionApi get_clock_presales_supply_lines_max_sequence GET /clock-presales-supply-lines/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in clock presales supply lines.
AuctionApi get_clock_supply_line_by_id GET /clock-supply-lines/{supplyLineId} supply:read - Returns a clock supply line.
AuctionApi get_clock_supply_lines_by_sequence_number GET /clock-supply-lines/sync/{sequenceNumber} supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 clock supply lines starting from a specified sequence number.
AuctionApi get_clock_supply_lines_max_sequence GET /clock-supply-lines/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in clock supply lines.
BaseItemsApi add_base_item POST /base-items catalog:write - Create a base item
BaseItemsApi delete_base_item DELETE /base-items/{baseItemId} catalog:write - Delete a base item
BaseItemsApi edit_base_item PUT /base-items/{baseItemId} catalog:write - Update a base item
BaseItemsApi get_base_item_by_id GET /base-items/{baseItemId} catalog:read - Return base-items
BaseItemsApi get_base_items_by_sequence_number GET /base-items/sync/{sequenceNumber} catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 base items starting from a specified sequence number.
BaseItemsApi get_base_items_max_sequence GET /base-items/current-max-sequence catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in base items.
BatchesApi add_batch POST /batches fulfillment:write - rate limit: 3.4 per second - burst limit: 1000 - Creates a batch.
BatchesApi combine_and_transform_batches POST /batches/combine-and-transform fulfillment:write - rate limit: 3.4 per second - burst limit: 1000 - Merge and transform multiple existing batches into a single new batch with the given modifications.
BatchesApi edit_batch PUT /batches/{batchId}/quantity-corrections fulfillment:write - rate limit: 3.4 per second - burst limit: 1000 - Update the quantity of a batch.
BatchesApi get_batch_by_id GET /batches/{batchId} fulfillment:read - Returns a batch.
BatchesApi get_batch_mutations_by_sequence_number GET /batches/mutations/sync/{sequenceNumber} fulfillment:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 batch mutations starting from a specified sequence number.
BatchesApi get_batch_mutations_max_sequence GET /batches/mutations/current-max-sequence fulfillment:read - Returns the maximum sequence number found in batch mutations.
BatchesApi get_batches GET /batches fulfillment:read - rate limit: 3.4 per second - burst limit: 1000 - Returns batches.
BatchesApi get_batches_by_sequence_number GET /batches/sync/{sequenceNumber} fulfillment:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 batches starting from a specified sequence number.
BatchesApi get_batches_max_sequence GET /batches/current-max-sequence fulfillment:read - Returns the maximum sequence number found in batches.
BatchesApi get_tray_labels_as_pdf_by_batch_ids GET /batches/stickers fulfillment:read - Returns tray stickers as pdf for batches.
BatchesApi transform_batch PUT /batches/{batchId}/transform fulfillment:write - rate limit: 3.4 per second - burst limit: 1000 - Transform a batch into a new batch with the given modifications.
BlanketOrdersApi add_blanket_order POST /blanket-orders contract:write - Creates a blanket order
BlanketOrdersApi delete_blanket_order DELETE /blanket-orders/{blanketOrderId} contract:write - Deletes a blanket order.
BlanketOrdersApi edit_blanket_order PUT /blanket-orders/{blanketOrderId} contract:write - Modifies an existing blanket order.
BlanketOrdersApi get_blanket_order_by_id GET /blanket-orders/{blanketOrderId} contract:read - Returns a blanket order by id.
BlanketOrdersApi get_blanket_orders_by_sequence_number GET /blanket-orders/sync/{sequenceNumber} contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 contracts starting from a specified sequence number.
BlanketOrdersApi get_blanket_orders_max_sequence GET /blanket-orders/current-max-sequence contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in blanket orders.
BlanketOrdersApi set_blanket_order_approved PATCH /blanket-orders/{blanketOrderId}/approve contract:write - Approves a blanket order
BundledOffersApi add_bundled_offer POST /bundled-offers supply:write - creates a bundled offer.
BundledOffersApi delete_bundled_offer DELETE /bundled-offers/{bundledOfferId} supply:write - delete a bundled offer
BundledOffersApi edit_bundled_offer PUT /bundled-offers/{bundledOfferId} supply:write - update a bundled offer
BundledOffersApi get_bundled_offer_by_bundled_offer_line_id GET /bundled-offers/by-bundled-offer-line-id supply:read - Returns a bundled offer.
BundledOffersApi get_bundled_offer_by_id GET /bundled-offers/{bundledOfferId} supply:read - Returns a bundled offer.
BundledOffersApi get_bundled_offers_by_sequence_number GET /bundled-offers/sync/{sequenceNumber} supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 Bundled offers starting from a specified sequence number.
BundledOffersApi get_bundled_offers_max_sequence GET /bundled-offers/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in bundled offers.
CatalogPricesApi add_weekly_supply_line POST /weekly-supply-lines supply:write - Creates a new weekly supply line for trade item.
CatalogPricesApi delete_weekly_supply_lines DELETE /weekly-supply-lines/{supplyLineId} supply:write - Deletes a weekly supply line.
CatalogPricesApi edit_continuous_stock PUT /trade-items/{tradeItemId}/continuous-stock supply:write - rate limit: 10 per second - burst limit: 1000 - Set availabilities for a trade item
CatalogPricesApi edit_weekly_base_supply PUT /trade-items/{tradeItemId}/base-supply/{year}/{week} supply:write - rate limit: 10 per second - burst limit: 1000 - Generates new weekly supply lines based on pre-entered price groups.
CatalogPricesApi edit_weekly_base_supply_lines PUT /trade-items/base-supply/{year}/{week} supply:write - rate limit: 10 per second - burst limit: 1000 - Generates new weekly supply lines for multiple trade items based on calculated and manual price groups.
CatalogPricesApi edit_weekly_supply_line PUT /weekly-supply-lines/{supplyLineId} supply:write - Updates a weekly supply line for trade item.
CatalogPricesApi get_continuous_stock GET /trade-items/{tradeItemId}/continuous-stock supply:read - Returns the availability of a trade item.
CatalogPricesApi get_trade_item_availabilities GET /trade-items/availabilities supply:read - rate limit: 2 per second - burst limit: 200 - Returns the current availability of all trade items.
CatalogPricesApi get_trade_item_availabilities_by_sequence_number GET /trade-items/availabilities/sync/{sequenceNumber} supply:read - Returns a list of max 1000 trade item availabilities starting from a specified sequence number.
CatalogPricesApi get_trade_item_availabilities_max_sequence GET /trade-items/availabilities/current-max-sequence supply:read - Returns the maximum sequence number found in trade item availabilities.
CatalogPricesApi get_weekly_base_supplies GET /trade-items/base-supply supply:read - rate limit: 1 per second - burst limit: 20 - Returns the base supply per year/week for trade items.
CatalogPricesApi set_trade_item_warehouse PATCH /trade-items/{tradeItemId}/warehouse supply:write - Add a warehouse for a trade item ( only continuous stock )
CatalogPricesApi set_weekly_base_supply_number_of_pieces PATCH /trade-items/{tradeItemId}/base-supply/{year}/{week} supply:write - rate limit: 10 per second - burst limit: 1000 - Patch the number of pieces of an existing base supply.
CollectionsApi add_collection POST /collections catalog:write - Create a collection.
CollectionsApi add_trade_items_to_collection POST /collections/{collectionId}/trade-items catalog:write - Add trade items to collection.
CollectionsApi delete_collection DELETE /collections/{collectionId} catalog:write - Delete a collection.
CollectionsApi delete_collection_trade_items DELETE /collections/{collectionId}/trade-items catalog:write - Remove trade items from collection.
CollectionsApi edit_collection PUT /collections/{collectionId} catalog:write - Update a collection.
CollectionsApi get_collection_by_id GET /collections/{collectionId} catalog:read - Returns an collection.
CollectionsApi get_collections_by_sequence_number GET /collections/sync/{sequenceNumber} catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 collections starting from a specified sequence number.
CollectionsApi get_collections_max_sequence GET /collections/current-max-sequence catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in collections.
CollectionsApi set_sort_order_for_collection PATCH /collections/{collectionId}/sort-order catalog:write - Set sort order for collection.
CommercialServiceTypesApi get_commercial_service_types GET /commercial-service-types catalog:read - Returns overview of commercial service types
CommercialServiceTypesApi get_commercial_service_types_by_sequence_number GET /commercial-service-types/sync/{sequenceNumber} catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 commercial service types starting from a specified sequence number.
CommercialServiceTypesApi get_commercial_service_types_max_sequence GET /commercial-service-types/current-max-sequence catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in commercial service types.
ConnectionsApi get_connections_by_sequence_number GET /connections/sync/{sequenceNumber} network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 connections starting from a specified sequence number.
ConnectionsApi get_connections_max_sequence GET /connections/current-max-sequence network:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in connections.
ContractTradeItemGroupsApi get_contract_trade_item_group_by_id GET /contract-trade-item-groups/{contractTradeItemGroupId} catalog:read - Returns an contract trade item group.
ContractTradeItemGroupsApi get_contract_trade_item_groups_by_sequence_number GET /contract-trade-item-groups/sync/{sequenceNumber} contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 contract trade item groups starting from a specified sequence number.
ContractTradeItemGroupsApi get_contract_trade_item_groups_max_sequence GET /contract-trade-item-groups/current-max-sequence contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in contract trade item groups.
ContractsApi add_contract POST /contracts contract:write - Creates a draft contract
ContractsApi add_new_contract_version POST /contracts/reference/{contractReference} contract:write - Creates a new version for an existing contract
ContractsApi approve_contract PATCH /contracts/{contractId}/approve contract:write - Sets the state of the contract to 'APPROVED' if already finalized by the customer.
ContractsApi approve_contract_by_reference PATCH /contracts/reference/{contractReference}/approve-contract contract:write - Sets the state of the contract to 'APPROVED' if already finalized by the customer.
ContractsApi approve_delete_contract DELETE /contracts/reference/{contractReference}/approve contract:write - Approves contract delete request created by customer
ContractsApi decline_contract PATCH /contracts/{contractId}/decline contract:write - Sets the state of the contract to 'DECLINED' if already finalized by the customer.
ContractsApi decline_contract2 PATCH /contracts/reference/{contractReference}/decline-contract contract:write - Sets the state of the contract to 'DECLINED' if already finalized by the customer.
ContractsApi decline_delete_contract DELETE /contracts/reference/{contractReference}/decline-delete contract:write - Declines contract delete request created by customer
ContractsApi edit_contract PUT /contracts/{contractId} contract:write - Updates a draft contract
ContractsApi edit_contract_by_reference PUT /contracts/reference/{contractReference} contract:write - Updates a draft contract
ContractsApi finalize_contract PATCH /contracts/{contractId}/finalize contract:write - Sets the contract status to 'FINALIZED' and offers the contract to the customer for approval.
ContractsApi finalize_contract_by_reference PATCH /contracts/reference/{contractReference}/finalize-contract contract:write - Sets the contract status to 'FINALIZED' and offers the contract to the customer for approval.
ContractsApi get_contract_attachment_by_id GET /contracts/attachments/{attachmentId} contract:read - Returns a contract attachment.
ContractsApi get_contract_by_id GET /contracts/{contractId} contract:read - Returns a contract.
ContractsApi get_contracts_by_sequence_number GET /contracts/sync/{sequenceNumber} contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 100 contracts starting from a specified sequence number.
ContractsApi get_contracts_max_sequence GET /contracts/current-max-sequence contract:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in contracts.
ContractsApi request_delete_contract DELETE /contracts/reference/{contractReference}/request contract:write - Deletes contract if contract is not yet approved. Requests delete by customer if already approved
CustomPackagesApi get_custom_package_by_id GET /custom-packages/{customPackageId} catalog:read - Get a custom package.
CustomPackagesApi get_custom_packages GET /custom-packages catalog:read - Returns custom packages.
CustomPackagesApi get_custom_packages_by_sequence_number GET /custom-packages/sync/{sequenceNumber} catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 custom packages starting from a specified sequence number.
CustomPackagesApi get_custom_packages_max_sequence GET /custom-packages/current-max-sequence catalog:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in custom packages.
CustomerOffersApi add_customer_offer POST /customer-offers supply:write - create a customer offer
CustomerOffersApi delete_customer_offers DELETE /customer-offers/{supplyLineId} supply:write - delete a customer offer
CustomerOffersApi edit_customer_offer PUT /customer-offers/{supplyLineId} supply:write - update a customer offer
CustomerStickersApi get_customer_sticker_pdf_by_id GET /customer-stickers/{stickerId} sticker:read - Returns customer sticker in pdf format
CustomerStickersApi get_customer_sticker_pdf_by_ids GET /customer-stickers sticker:read - Returns customer stickers in pdf format. Pages are duplicated based on the number of copies in the customer sticker.
CustomerStickersApi get_customer_stickers_by_sequence_number GET /customer-stickers/sync/{sequenceNumber} sticker:read - Returns a list of max 1000 customer stickers metadata starting from a specified sequence number.
CustomerStickersApi get_customer_stickers_max_sequence GET /customer-stickers/current-max-sequence sticker:read - Returns the maximum sequence number found in customer stickers.
CustomerStickersApi set_customer_stickers_is_handled PATCH /customer-stickers/handled sticker:write - Indicate which stickers are printed and placed.
DeliveryConditionSetsApi get_delivery_condition_set_by_id GET /delivery-condition-sets/{deliveryConditionSetId} delivery-conditions:read - Returns a delivery condition set.
DeliveryConditionSetsApi get_delivery_condition_sets GET /delivery-condition-sets delivery-conditions:read - Returns delivery condition sets.
DeliveryConditionSetsApi get_delivery_condition_sets_by_sequence_number GET /delivery-condition-sets/sync/{sequenceNumber} delivery-conditions:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 100 delivery condition sets starting from a specified sequence number.
DeliveryConditionSetsApi get_delivery_condition_sets_max_sequence GET /delivery-condition-sets/current-max-sequence delivery-conditions:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in delivery condition sets.
DeliveryLocationsApi get_delivery_location_max_sequence GET /delivery-locations/current-max-sequence organization:read - rate limit: 2.0 per second - burst limit: 200 - Returns the maximum sequence number found in warehouses.
DeliveryLocationsApi get_delivery_locations_by_sequence_number GET /delivery-locations/sync/{sequenceNumber} organization:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 customer delivery locations starting from a specified sequence number.
DeliveryOrdersApi add_clock_delivery_order POST /delivery-orders/{deliveryOrderId}/auction fulfillment:write - Create a delivery order for auction warehouse.
DeliveryOrdersApi add_delivery_order_goods_movement POST /delivery-orders/{deliveryOrderId}/goods-movement fulfillment:write - Create a delivery order for external warehouse.
DeliveryOrdersApi delete_clock_delivery_order DELETE /delivery-orders/{deliveryOrderId}/auction fulfillment:write - Delete a delivery order for auction.
DeliveryOrdersApi delete_delivery_order_goods_movement DELETE /delivery-orders/{deliveryOrderId}/goods-movement fulfillment:write - Delete a delivery order for goods movement.
DeliveryOrdersApi get_delivery_order_by_id GET /delivery-orders/{deliveryOrderId} fulfillment:read - Returns a delivery order.
DeliveryOrdersApi get_delivery_orders_by_sequence_number GET /delivery-orders/sync/{sequenceNumber} fulfillment:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 delivery orders starting from a specified sequence number.
DeliveryOrdersApi get_delivery_orders_max_sequence GET /delivery-orders/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in delivery orders.
DeliveryOrdersApi get_tray_labels_as_pdf_by_id GET /delivery-orders/{deliveryOrderId}/stickers fulfillment:read - Returns tray stickers as pdf for a delivery order.
DirectSalesApi add_supply_line POST /supply-lines supply:write - Create a supply line with type BATCH_PRICE
DirectSalesApi delete_supply_line DELETE /supply-lines/{supplyLineId} supply:write - Delete a supply line
DirectSalesApi edit_base_supply PUT /batches/{batchId}/base-supply supply:write - Set base supply for a batch. Supply lines will be generated based on pre-entered price groups.
DirectSalesApi get_supply_line_by_id GET /supply-lines/{supplyLineId} supply:read - Returns a supply line.
DirectSalesApi get_supply_lines GET /supply-lines supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns supply lines created within the given timeframe
DirectSalesApi get_supply_lines_by_sequence_number GET /supply-lines/sync/{sequenceNumber} supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 supply lines starting from a specified sequence number.
DirectSalesApi get_supply_lines_max_sequence GET /supply-lines/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in supply lines.
DirectSalesApi set_supply_line_price PATCH /supply-lines/{supplyLineId}/price supply:write - Update the price of the supply line with type BATCH_PRICE.
DirectSalesApi set_supply_line_status PATCH /supply-lines/{supplyLineId}/status supply:write - Update the status of the supply line with type BATCH_PRICE.
DomainErrorCodesApi get_domain_error_codes GET /domain-error-codes - Returns all domain error codes.
FloraXchangeSettingsApi migrate_sales_order_management POST /floraxchange-settings/migrate-sales-order-management fulfillment:write - Migrate sales order management from FX to Floriday
FulfillmentOrdersApi add_fulfillment_order POST /fulfillment-orders fulfillment:write - Creates a fulfillment order.
FulfillmentOrdersApi add_fulfillment_order_correction POST /fulfillment-orders/{fulfillmentOrderId}/corrections fulfillment:write - Corrects a fulfillment order.
FulfillmentOrdersApi delete_fulfillment_order DELETE /fulfillment-orders/{fulfillmentOrderId} fulfillment:write - Delete a fulfillment order.
FulfillmentOrdersApi edit_fulfillment_order PUT /fulfillment-orders/{fulfillmentOrderId} fulfillment:write - Updates a fulfillment order.
FulfillmentOrdersApi get_fulfillment_order_by_id GET /fulfillment-orders/{fulfillmentOrderId} fulfillment:read - Returns a fulfillment order.
FulfillmentOrdersApi get_fulfillment_order_corrections_by_id GET /fulfillment-orders/{fulfillmentOrderId}/corrections fulfillment:read - Returns fulfillment order corrections.
FulfillmentOrdersApi get_fulfillment_order_status_by_id GET /fulfillment-orders/{fulfillmentOrderId}/status fulfillment:read - Returns the status of a fulfillment order.
FulfillmentOrdersApi get_fulfillment_orders_by_sequence_number GET /fulfillment-orders/sync/{sequenceNumber} fulfillment:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 fulfillment orders starting from a specified sequence number.
FulfillmentOrdersApi get_fulfillment_orders_max_sequence GET /fulfillment-orders/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in fulfillment orders.
FulfillmentOrdersApi get_logistic_labels_by_id GET /fulfillment-orders/{fulfillmentOrderId}/logistic-labels fulfillment:read - rate limit: 1.0 per second - burst limit: 60 - Returns logistic labels (SSCC or delivery notes) as pdf for a fulfillment order.
FulfillmentOrdersApi get_tray_labels_as_pdf_by_fulfillment_order_id GET /fulfillment-orders/{fulfillmentOrderId}/stickers fulfillment:read - Returns tray stickers as pdf for a fulfillment order.
IdentitiesApi get_identity GET /auth/key Provides the identity associated with an api key.
InvoiceLinesApi get_invoice_lines_by_sales_order_id GET /invoice-lines/{salesOrderId} sales-order:read - Returns invoice lines by sales order
InvoiceLinesApi get_invoice_lines_by_sequence_number GET /invoice-lines/sync/{sequenceNumber} sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 invoice lines starting from a specified sequence number.
InvoiceLinesApi get_invoice_lines_max_sequence GET /invoice-lines/current-max-sequence sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in invoice lines.
MediaApi add_image POST /media catalog:write - rate limit: 2.0 per second - burst limit: 200 - Uploads an image.
OrderRequestsApi get_order_request_by_id GET /order-requests/{orderRequestId} sales-order:read - Returns the order request by id.
OrderRequestsApi get_order_requests_by_sequence_number GET /order-requests/sync/{sequenceNumber} sales-order:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 order requests starting from a specified sequence number.
OrderRequestsApi get_order_requests_max_sequence GET /order-requests/current-max-sequence sales-order:read - Returns the maximum sequence number found in order request.
OrderRequestsApi set_order_request_accepted PATCH /order-requests/{orderRequestId}/accept sales-order:write - Accepts the order request.
OrderRequestsApi set_order_request_rejected PATCH /order-requests/{orderRequestId}/reject sales-order:write - Rejects the order request.
OrganizationsApi get_organization_by_company_gln GET /organizations organization:read - Returns an organization by company GLN.
OrganizationsApi get_organization_by_id GET /organizations/{organizationId} organization:read - Returns an organization.
OrganizationsApi get_organizations_by_sequence_number GET /organizations/sync/{sequenceNumber} organization:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 organizations starting from a specified sequence number.
OrganizationsApi get_organizations_max_sequence GET /organizations/current-max-sequence organization:read - Returns the maximum sequence number found in organizations.
PackingConfigurationRequestsApi get_packing_configuration_request_by_id GET /packing-configuration-requests/{packingConfigurationRequestId} catalog:read - Returns a packing configuration request.
PackingConfigurationRequestsApi get_packing_configuration_requests_by_sequence_number GET /packing-configuration-requests/sync/{sequenceNumber} catalog:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 packing configuration request starting from a specified sequence number.
PackingConfigurationRequestsApi get_packing_configuration_requests_max_sequence GET /packing-configuration-requests/current-max-sequence catalog:read - Returns the maximum sequence number found in packing configuration request.
PackingConfigurationRequestsApi set_packing_configuration_request_accepted PATCH /packing-configuration-requests/{packingConfigurationRequestId}/accept catalog:write - Accepts the packing configuration request.
PackingConfigurationRequestsApi set_packing_configuration_request_rejected PATCH /packing-configuration-requests/{packingConfigurationRequestId}/reject catalog:write - Rejects the packing configuration request.
PlantPassportsApi get_plant_passport_pdf POST /plant-passports fulfillment:read - Returns the plant passport PDF for the BatchIds.
PlantPassportsApi get_plant_passport_pdf_by_sales_channel_order_id GET /plant-passports/by-sales-channel-order-id/{salesChannelOrderId} fulfillment:read - Returns plant passport PDF for the sales order.
PlantPassportsApi get_plant_passport_pdf_by_sales_order_id GET /plant-passports/by-sales-order-id/{salesOrderId} fulfillment:read - Returns plant passport PDF for the sales order.
PriceGroupsApi get_price_group_by_id GET /price-groups/{priceGroupId} supply:read - Returns a price group.
PriceGroupsApi get_price_groups_by_sequence_number GET /price-groups/sync/{sequenceNumber} supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 price groups starting from a specified sequence number.
PriceGroupsApi get_price_groups_max_sequence GET /price-groups/current-max-sequence supply:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in price groups.
SalesOrderCorrectionRequestsApi accept_sales_order_correction_request PATCH /sales-order-correction-requests/{salesOrderCorrectionRequestId}/accept sales-order:write - Accept sales order correction request.
SalesOrderCorrectionRequestsApi add_sales_order_correction_request POST /sales-order-correction-requests sales-order:write - Creates a new sales order correction request.
SalesOrderCorrectionRequestsApi decline_sales_order_correction_request PATCH /sales-order-correction-requests/{salesOrderCorrectionRequestId}/decline sales-order:write - Decline sales order correction request.
SalesOrderCorrectionRequestsApi delete_sales_order_correction_request DELETE /sales-order-correction-requests/{salesOrderCorrectionRequestId} sales-order:write - Delete a sales order correction request.
SalesOrderCorrectionRequestsApi get_sales_order_correction_request_by_id GET /sales-order-correction-requests/{salesOrderCorrectionRequestId} sales-order:read - Returns a sales order correction request.
SalesOrderCorrectionRequestsApi get_sales_order_correction_requests_by_sequence_number GET /sales-order-correction-requests/sync/{sequenceNumber} sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 sales order correction requests starting from a specified sequence number.
SalesOrderCorrectionRequestsApi get_sales_order_correction_requests_max_sequence GET /sales-order-correction-requests/current-max-sequence sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns the maximum sequence number found in sales order correction requests.
SalesOrdersApi add_sales_order POST /sales-orders sales-order:write - rate limit: 3.4 per second - burst limit: 1000 - Creates a new sales order.
SalesOrdersApi add_sales_order_external_integration POST /sales-orders/external-integration sales-order:write - rate limit: 3.4 per second - burst limit: 1000 - Creates a new sales order.
SalesOrdersApi get_sales_order_by_id GET /sales-orders/{salesOrderId} sales-order:read - Returns a sales order.
SalesOrdersApi get_sales_order_by_id_and_version GET /sales-orders/{salesOrderId}/version sales-order:read - Returns the sales order by ID and version.
SalesOrdersApi get_sales_orders GET /sales-orders sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns sales orders.
SalesOrdersApi get_sales_orders_by_sequence_number GET /sales-orders/sync/{sequenceNumber} sales-order:read - rate limit: 3.4 per second - burst limit: 1000 - Returns a list of max 1000 sales orders starting from a specified sequence number.
SalesOrdersApi get_sales_orders_max_sequence GET /sales-orders/current-max-sequence sales-order:read - Returns the maximum sequence number found in sales orders.
SalesOrdersApi set_sales_order_cancelled PATCH /sales-orders/{salesOrderId}/cancel sales-order:write - Cancel a sales order that is still in status ACCEPTED.
SalesOrdersApi set_sales_order_committed PATCH /sales-orders/{salesOrderId}/commit sales-order:write - Commit a sales order that is still in status ACCEPTED.
SettingsApi set_florecom_order_messages_deactivated PATCH /settings/deactivate-florecom-order-messages fulfillment:write - Deactivates Florecom order/orderresponse messages
SupplyRequestsApi get_supply_request_by_id GET /supply-requests/{supplyRequestId} supply:read - Returns a supply request.
SupplyRequestsApi get_supply_requests_by_sequence_number GET /supply-requests/sync/{sequenceNumber} supply:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 supply requests starting from a specified sequence number.
SupplyRequestsApi get_supply_requests_max_sequence GET /supply-requests/current-max-sequence supply:read - Returns the maximum sequence number found in supply requests.
SupplyRequestsApi set_supply_request_line_accepted PATCH /supply-requests/line/{supplyRequestLineId}/accept supply:write - Accepts the supply request line.
SupplyRequestsApi set_supply_request_line_rejected PATCH /supply-requests/line/{supplyRequestLineId}/reject supply:write - Rejects the supply request line.
TradeItemRequestsApi get_trade_item_request_by_id GET /trade-item-requests/{tradeItemRequestId} catalog:read - Returns a trade item request.
TradeItemRequestsApi get_trade_item_requests_by_sequence_number GET /trade-item-requests/sync/{sequenceNumber} catalog:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 trade item requests starting from a specified sequence number.
TradeItemRequestsApi get_trade_item_requests_max_sequence GET /trade-item-requests/current-max-sequence catalog:read - Returns the maximum sequence number found in trade item requests.
TradeItemRequestsApi set_trade_item_request_accepted PATCH /trade-item-requests/{tradeItemRequestId}/accept/{tradeItemId} catalog:write - Accepts the trade item request.
TradeItemRequestsApi set_trade_item_request_rejected PATCH /trade-item-requests/{tradeItemRequestId}/reject catalog:write - Rejects the trade item request.
TradeItemsApi add_trade_item POST /trade-items catalog:write - Creates a new trade item.
TradeItemsApi add_trade_item_variant POST /trade-items/variants catalog:write - Creates a new trade item variant.
TradeItemsApi delete_trade_item DELETE /trade-items/{tradeItemId} catalog:write - Deletes a trade item.
TradeItemsApi edit_trade_item PUT /trade-items/{tradeItemId} catalog:write - Updates a trade item.
TradeItemsApi edit_trade_item_variant PUT /trade-items/variants/{tradeItemId} catalog:write - Update a trade item variant.
TradeItemsApi get_trade_item_by_id GET /trade-items/{tradeItemId} catalog:read - Returns a trade item.
TradeItemsApi get_trade_item_by_id_and_version GET /trade-items/{tradeItemId}/{version} catalog:read - Returns a trade item.
TradeItemsApi get_trade_items GET /trade-items catalog:read - Returns trade items.
TradeItemsApi get_trade_items_by_sequence_number GET /trade-items/sync/{sequenceNumber} catalog:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 trade items starting from a specified sequence number.
TradeItemsApi get_trade_items_max_sequence GET /trade-items/current-max-sequence catalog:read - Returns the maximum sequence number found in trade items.
TradeItemsApi get_trade_items_summary GET /trade-items/summary catalog:read - rate limit: 2.0 per second - burst limit: 200 - Returns public trade item information of a supplier.
TradeSettingsApi get_customer_trade_settings_by_organization_id GET /trade-settings/customer/{customerOrganizationId} network:read - Returns the trade settings for a given customer.
TradeSettingsApi get_customer_trade_settings_by_sequence_number GET /trade-settings/customer/sync/{sequenceNumber} network:read - Returns a list of max 1000 customer trade settings starting from a specified sequence number.
TradeSettingsApi get_customer_trade_settings_max_sequence GET /trade-settings/customer/max-sequence network:read - Returns the maximum sequence number found in customer trade settings. The customer trade settings sequence differs from the supplier trade settings sequence.
TradeSettingsApi get_supplier_trade_settings_from_organization GET /trade-settings/supplier/current-organization network:read - Returns the trade settings of the current organization.
WarehouseProvidersApi get_fulfillment_orders_inbound_by_sequence_number GET /fulfillment-orders/inbound/sync/{sequenceNumber} fulfillment:read - Returns a list of inbound fulfillment orders.
WarehouseProvidersApi set_fulfillment_order_receipt PUT /fulfillment-orders/{fulfillmentOrderId}/goods-receipt fulfillment:write - Receive a inbound fulfillment order.
WarehousesApi get_warehouses GET /warehouses organization:read - Returns warehouses.
WarehousesApi get_warehouses_auction GET /warehouses/auction organization:read - Returns warehouses with auction capability.
WarehousesApi get_warehouses_by_sequence_number GET /warehouses/sync/{sequenceNumber} organization:read - rate limit: 2.0 per second - burst limit: 200 - Returns a list of max 1000 warehouses starting from a specified sequence number.
WarehousesApi get_warehouses_external_stock GET /warehouses/external-stock organization:read - Returns warehouses for external stock management.
WarehousesApi get_warehouses_max_sequence GET /warehouses/current-max-sequence organization:read - rate limit: 2.0 per second - burst limit: 200 - Returns the maximum sequence number found in warehouses.
WebhooksApi add_webhook_subscription POST /webhooks/subscriptions webhooks:write - Subscribe to a events webhook.
WebhooksApi delete_webhook_subscription DELETE /webhooks/subscriptions webhooks:write - Delete a events webhook.
WeeklyBaseSupplyCountersApi add_weekly_base_supply_counter_template_to_trade_item_async PUT /weekly-base-supply-counters/templates/{weeklyBaseSupplyCounterTemplateId}/add-to-trade-item supply:write - Add WeeklyBaseSupplyCounterTemplate to trade item.
WeeklyBaseSupplyCountersApi claim_number_of_pieces_from_weekly_base_supply_counter PUT /weekly-base-supply-counters/claim/{weeklyBaseSupplyCounterId} supply:write - Claim NumberOfPieces from weekly base supply counter.
WeeklyBaseSupplyCountersApi delete_weekly_base_supply_counter_template DELETE /weekly-base-supply-counters/templates/{weeklyBaseSupplyCounterTemplateId} supply:write - Delete weekly base supply counter template.
WeeklyBaseSupplyCountersApi get_weekly_base_supply_counter GET /weekly-base-supply-counters/{weeklyBaseSupplyCounterId} supply:read - Returns a weekly base supply counter.
WeeklyBaseSupplyCountersApi get_weekly_base_supply_counter_by_template_id GET /weekly-base-supply-counters/by-template-id/{weeklyBaseSupplyCounterTemplateId} supply:read - Returns weekly base supply counters by templateId.
WeeklyBaseSupplyCountersApi get_weekly_base_supply_template_by_id GET /weekly-base-supply-counters/templates/{weeklyBaseSupplyCounterTemplateId} supply:read - Returns a weekly base supply counter template.
WeeklyBaseSupplyCountersApi get_weekly_base_supply_templates GET /weekly-base-supply-counters/templates supply:read - Returns weekly base supply counter templates.
WeeklyBaseSupplyCountersApi upsert_weekly_base_supply_counter_template PUT /weekly-base-supply-counters/templates supply:write - Upsert weekly base supply counter template.
WeeklySupplyLineCountersApi add_weekly_supply_line_counter POST /weekly-supply-line-counters supply:write - Creates a new WeeklySupplyLineCounter.
WeeklySupplyLineCountersApi add_weekly_supply_line_counter_to_supply_line PATCH /weekly-supply-line-counters/{weeklySupplyLineCounterId}/add-to-supplyline/{supplyLineId} supply:write - Links the supply line to the WeeklySupplyLineCounter. The `numberOfPieces` in the supply line will be based on the counter.
WeeklySupplyLineCountersApi delete_weekly_supply_line_counter DELETE /weekly-supply-line-counters/{weeklySupplyLineCounterId} supply:write - Deletes the WeeklySupplyLineCounter and removes all the supply line links.
WeeklySupplyLineCountersApi get_weekly_supply_line_counter_by_id GET /weekly-supply-line-counters/{weeklySupplyLineCounterId} supply:read - Returns the WeeklySupplyLineCounters by id.
WeeklySupplyLineCountersApi get_weekly_supply_line_counters GET /weekly-supply-line-counters supply:read - Returns all available WeeklySupplyLineCounters created via the Suppliers API.
WeeklySupplyLineCountersApi remove_weekly_supply_line_counter_from_supply_line PATCH /weekly-supply-line-counters/{weeklySupplyLineCounterId}/remove-from-supplyline/{supplyLineId} supply:write - Removes the supply line from the WeeklySupplyLineCounter.

Documentation For Models

Documentation For Authorization

JWT Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

X-Api-Key

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

Author

About

Python client for the Floriday supplier api

Resources

Readme

License

GPL-3.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

8 tags

Packages

No packages published

Languages