### Example C# Integration with NSwag Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Provides a reference to an example integration written in C#, which utilizes NSwag to generate an API client for interacting with the Ongoing WMS REST API. ```C# Click here to see an example integration written in C#. We used NSwag to generate a client for accessing the API, and then used the client to make various requests. ``` -------------------------------- ### Get All Article Classes Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves a list of all available article classes. Useful for understanding the classification system within the warehouse. ```REST GET /api/v1/articles/classes ``` -------------------------------- ### Get All Articles Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all articles that match specified search criteria. This is useful for bulk retrieval and filtering of articles. ```REST GET /api/v1/articles ``` -------------------------------- ### Get All Order Statuses Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves a list of all available order statuses. ```HTTP GET /api/v1/orders/statuses ``` -------------------------------- ### Get All Orders Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all orders that match the specified search criteria. ```HTTP GET /api/v1/orders ``` -------------------------------- ### Get Files for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all files attached to a specific order. ```HTTP GET /api/v1/orders/{orderId}/files ``` -------------------------------- ### Get All Order Classes Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves a list of all available order classes. ```HTTP GET /api/v1/orders/classes ``` -------------------------------- ### Get Article Materials Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves the materials associated with a specific article using its system ID. Useful for understanding the components of an article. ```REST GET /api/v1/articles/{articleSystemId}/materials ``` -------------------------------- ### Get Article Files Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all files attached to a specific article, identified by its system ID. Useful for accessing associated documents or media. ```REST GET /api/v1/articles/{articleSystemId}/files ``` -------------------------------- ### Get Article by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves a specific article using its system ID. This is a fundamental operation for accessing article details. ```REST GET /api/v1/articles/{articleSystemId} ``` -------------------------------- ### Get Article Structure Definitions Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all structure rows for structure articles and production articles using their system IDs. Essential for understanding article composition. ```REST GET /api/v1/articles/{articleSystemId}/structureDefinition ``` -------------------------------- ### Get Order Way of Delivery Types Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all available order way of delivery types. ```HTTP GET /api/v1/orders/wayOfDeliveryTypes ``` -------------------------------- ### Get Order Pickability Statuses Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves the pickability statuses for orders. It's more efficient to request statuses for multiple orders at once. Possible statuses include 'Ok', 'ByPriority', 'NotByPriority', 'NotOk', and 'NothingToAllocate'. ```HTTP GET /api/v1/orders/pickability ``` -------------------------------- ### Get Order by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves a specific order using its unique identifier. ```HTTP GET /api/v1/orders/{orderId} ``` -------------------------------- ### Get Multiple Article Materials Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves the materials for several articles simultaneously. This endpoint is efficient for batch processing of article material data. ```REST GET /api/v1/articles/materials ``` -------------------------------- ### Get All Inventory Adjustments Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all inventory adjustments that match specified search criteria. Useful for auditing and tracking stock level changes. ```REST GET /api/v1/inventoryAdjustments ``` -------------------------------- ### Get Article Dangerous Goods Info Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves the dangerous goods information for a specific article using its system ID. ```REST GET /api/v1/articles/{articleSystemId}/dangerousGoods ``` -------------------------------- ### Get Historical Inventory Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves historical stock balances for all articles at a specific point in time. Useful for historical analysis and auditing. ```REST GET /api/v1/articles/historicalInventory ``` -------------------------------- ### Order Management Endpoints Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This section details the various GET, POST, PATCH, and PUT operations available for managing orders within the Ongoing Warehouse system. These include retrieving order details, updating order information, and creating new orders with various associated data like addresses, transporters, and line items. ```REST GET /PickedArticleItemParcelType GET /PickedArticleItemParcelAdvanced GET /PickedArticleItemParcelTracking GET /PickedArticleItemParcelParent GET /PickedArticleItemParentParcelType GET /PickedArticleItemParentParcelAdvanced GET /PickedArticleItemPurchaseOrderInfo GET /OrderPickedArticlePrices GET /OrderPickedArticleItemReturnOrderInfo GET /OrderLinePrices GET /OrderLineFreeValues GET /OrderLineVat GET /OrderLinePickOrderInfo GET /OrderTransporter GET /OrderTransporterContract GET /OrderTransporterContractPaymentAdvanced GET /OrderTracking GET /OrderTrackingFreightPriceInfo GET /OrderClass GET /OrderShipmentInfo GET /OrderShipmentParcel GET /OrderModelAdvanced GET /OrderTextLine GET /OrderTransportStatusEvent GET /OrderTransportStatus GET /OrderTransportStatusEventParcel GET /OrderAdditionalAddress GET /OrderAdditionalAddressClass GET /OrderAdditionalAddressFreeValues GET /WayBillRowModel GET /WayBillRowParcelTypeModel POST /WaybillRowResponse POST /WayBillRowModel POST /WaybillParcelParcelType GET /OrderInvoiceChargeModel GET /OrderInvoiceArticleModel GET /OrderInvoiceUserInfo PATCH /OrderResponse PATCH /OrderNumberModel PATCH /GoodsOwnerOrderIdModel PATCH /OrderClassesModel POST /OrderClass PATCH /OrderTransporterModel PATCH /OrderTransporterPayment PATCH /OrderTransporterConsigneePays PATCH /OrderTransporterThirdPartyPays PATCH /OrderReturnWaybill PATCH /ServicePointCode PATCH /OrderStatus PATCH /OrderWaybill PATCH /OrderDeliveryDate PATCH /OrderRemark PATCH /OrderWarehouseInstruction PATCH /OrderReportedNumberOfItemsModel PATCH /CustomerLinePriceModel PATCH /OrderLineCommentModel PATCH /LinePriceModel PATCH /OrderReportedReturnedNumberOfItemsModel POST /OrderResponse POST /OrderModel POST /OrderConsignee POST /OrderConsigneeAddressAdvanced POST /OrderConsigneeCustomerNotification POST /OrderConsigneeTransporterContract POST /OrderConsigneeInvoiceAddress POST /OrderConsigneeInvoiceAddressAdvanced POST /OrderConsigneeCustomerInvoiceNotification POST /OrderAddressClass POST /OrderConsigneeFreeValues POST /OrderNotification POST /OrderTransporter POST /OrderTransporterPayment POST /OrderTransporterConsigneePays POST /OrderTransporterThirdPartyPays POST /OrderTransporterSenderPaysPays POST /OrderReturnTransporter POST /OrderLine POST /OrderLinePrices POST /OrderLineFreeValues POST /OrderLineVat POST /OrderCustomsInfo POST /OrderAdvanced POST /OrderTextLine POST /OrderAdditionalAddress POST /OrderAdditionalAddressClasss POST /OrderAdditionalAddressFreeValues POST /OrderMarketPlace PUT /OrderTextLineResponse PUT /OrderTextLineModel PATCH /OrderFreeText1Model PATCH /OrderFreeText2Model PATCH /OrderFreeText3Model PATCH /FreightPrice ``` -------------------------------- ### Get Order Types by Goods Owner Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all order types associated with a particular goods owner. ```HTTP GET /api/v1/orders/types ``` -------------------------------- ### Get Invoice Charges for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all invoice charges for a specific order. Requires additional API user permissions configured in Administration->Integration->API for goods owners. ```HTTP GET /api/v1/orders/{orderId}/invoiceCharges ``` -------------------------------- ### Get Inventory Per Warehouse Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves inventory information for articles, specified per warehouse, matching given filters. Provides a warehouse-specific inventory overview. ```REST GET /api/v1/articles/inventoryPerWarehouse ``` -------------------------------- ### Get All Structure Definitions by Article Numbers Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all structure rows for structure and production articles by using their article numbers. Facilitates bulk retrieval of structure data. ```REST GET /api/v1/articles/structureDefinitions ``` -------------------------------- ### Get Waybill Rows for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all waybill rows associated with a specific order. ```HTTP GET /api/v1/orders/{orderId}/wayBillRows ``` -------------------------------- ### Get Specific Inventory Adjustment Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves details of a specific inventory adjustment using its unique adjustment ID. Provides a granular view of stock changes. ```REST GET /api/v1/inventoryAdjustments/{inventoryId} ``` -------------------------------- ### Get Article Dangerous Goods by Article Number Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves dangerous goods information for articles using their article numbers. Allows for batch retrieval based on article numbers. ```REST GET /api/v1/articles/dangerousGoods ``` -------------------------------- ### Update Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing order. Note that orders cannot be updated once the warehouse has started processing them. ```HTTP PUT /api/v1/orders/{orderId} ``` -------------------------------- ### Cancel Order by Order Number Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Cancels an order using its order number. This action is only allowed if the warehouse has not yet started processing the order. ```HTTP DELETE /api/v1/orders ``` -------------------------------- ### HTTP Basic Authentication Header Generation Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Demonstrates how to construct the 'Authorization' header for HTTP Basic Authentication by combining username and password, encoding them in Base64, and prepending 'Basic '. ```General var userNameAndPassword = Base64Encode(userName + ":" + passWord); var authenticationHeader = "Basic " + userNameAndPassword; ``` -------------------------------- ### Create File for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new file and attaches it to a specific order. ```HTTP POST /api/v1/orders/{orderId}/files ``` -------------------------------- ### Create Article File Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new file and attaches it to a specified article. This allows for associating new files with existing articles. ```REST POST /api/v1/articles/{articleSystemId}/files ``` -------------------------------- ### Manage Return Orders - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Enables comprehensive management of return orders, including retrieval, creation, cancellation, and status updates. Supports fetching by ID, listing with criteria, and modifying status or dates. ```REST GET /api/v1/returnOrders/{returnOrderId} DELETE /api/v1/returnOrders/{returnOrderId} GET /api/v1/returnOrders PUT /api/v1/returnOrders DELETE /api/v1/returnOrders PATCH /api/v1/returnOrders/{returnOrderId}/returnOrderStatus PATCH /api/v1/returnOrders/{returnOrderId}/freeDateTime1 ``` -------------------------------- ### Manage Article Items Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Provides detailed stock information for article items, including batch and serial numbers. Allows for managing article item statuses and retrieving items based on search criteria. ```REST GET /api/v1/articleItems/statuses PUT /api/v1/articleItems/statuses GET /api/v1/articleItems PATCH /api/v1/articleItems/{articleItemId}/isLocked ``` -------------------------------- ### Generate Client Code with OpenAPI Specification Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This snippet explains how to use the provided OpenAPI specification file to automatically generate client code for accessing the Ongoing WMS REST API using tools like Swagger CodeGen or NSwag. ```General Using tools such as Swagger CodeGen or NSwag to automatically generate client code which lets you access the API. ``` -------------------------------- ### Create or Update Article File Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new file or updates an existing one attached to an article. The filename is used to determine if the file already exists. ```REST PUT /api/v1/articles/{articleSystemId}/files ``` -------------------------------- ### Create or Update Article Class Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new article class or updates an existing one if a class with the specified code already exists. Manages article categorization. ```REST PUT /api/v1/articles/classes ``` -------------------------------- ### Create or Update Article Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new article or updates an existing one based on the article number. If the article doesn't exist, it will be created. ```REST PUT /api/v1/articles ``` -------------------------------- ### Return Order Management Endpoints Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This section details the endpoints for managing return orders. It allows for retrieving return order information, status, and associated data, as well as posting and patching return order details. ```REST GET /ReturnCausesModel GET /ReturnCauseModel POST /ReturnCauseResponse POST /ReturnCauseModel GET /ReturnOrderModel GET /ReturnOrderInfo GET /ReturnOrderStatus GET /ReturnOrderWarehouse GET /ReturnOrderFreeValues GET /ReturnOrderCreatedBy GET /ReturnOrderCustomerOrderInfo GET /ReturnOrderLine GET /ReturnOrderLineCustomerOrderLine GET /ReturnOrderLineArticle GET /ReturnedArticleItem POST /ReturnOrderResponse POST /ReturnOrderModel POST /ReturnOrderCustomerOrder POST /ReturnOrderLine POST /ReturnOrderLineCustomerOrderLine POST /ReturnOrderTracking POST /ReturnOrderFreeValuesModel GET /ReturnOrderStatusesModel GET /ReturnOrderStatusModel PATCH /ReturnOrderResponse PATCH /ReturnOrderStatus PATCH /ReturnOrderFreeDateTime1 ``` -------------------------------- ### Manage Purchase Orders Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Endpoints for retrieving, creating, updating, and canceling purchase orders. Includes operations for managing purchase order lines and attachments. ```REST GET /api/v1/purchaseOrders/statuses GET /api/v1/purchaseOrders/types GET /api/v1/purchaseOrders/{purchaseOrderId} PUT /api/v1/purchaseOrders/{purchaseOrderId} DELETE /api/v1/purchaseOrders/{purchaseOrderId} GET /api/v1/purchaseOrders PUT /api/v1/purchaseOrders DELETE /api/v1/purchaseOrders PATCH /api/v1/purchaseOrders/{purchaseOrderId}/lines/{purchaseOrderLineId}/freeText1 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/lines/{purchaseOrderLineId}/freeDecimal1 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/lines/{purchaseOrderLineId}/freeText2 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/lines/{purchaseOrderLineId}/setReportedNumberOfItemsToReceivedNumberOfItems PATCH /api/v1/purchaseOrders/{purchaseOrderId}/lines/{purchaseOrderLineId}/reportedNumberOfItems PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeText1 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeText2 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeText3 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeText4 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeText5 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeBool1 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/freeBool2 PATCH /api/v1/purchaseOrders/{purchaseOrderId}/inDate PATCH /api/v1/purchaseOrders/{purchaseOrderId}/advisedDate PATCH /api/v1/purchaseOrders/{purchaseOrderId}/purchaseOrderStatus PATCH /api/v1/purchaseOrders/{purchaseOrderId}/purchaseOrderNumber PUT /api/v1/purchaseOrders/{purchaseOrderId}/articleItems GET /api/v1/purchaseOrders/{purchaseOrderId}/files POST /api/v1/purchaseOrders/{purchaseOrderId}/files PUT /api/v1/purchaseOrders/{purchaseOrderId}/files PUT /api/v1/purchaseOrders/{purchaseOrderId}/files/{fileId} ``` -------------------------------- ### Manage Production Orders - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Enables the creation, retrieval, and updating of production orders. Supports fetching by ID, listing with criteria, and modifying various boolean and text fields. ```REST GET /api/v1/productionOrders/{productionOrderId} GET /api/v1/productionOrders PUT /api/v1/productionOrders PATCH /api/v1/productionOrders/{productionOrderId}/freeBoolean1 PATCH /api/v1/productionOrders/{productionOrderId}/freeBoolean2 PATCH /api/v1/productionOrders/{productionOrderId}/freeText1 ``` -------------------------------- ### Retrieve Return Order Statuses - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Fetches all available status types for return orders. ```REST GET /api/v1/returnOrders/statuses ``` -------------------------------- ### Create or Update File for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates or updates a file attached to an order. The system uses the filename to determine if the file already exists. ```HTTP PUT /api/v1/orders/{orderId}/files ``` -------------------------------- ### Purchase Order Management Endpoints Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This section outlines the endpoints for managing purchase orders. It includes functionalities to retrieve various purchase order details, statuses, supplier information, and line items, as well as patching and posting purchase order data. ```REST GET /PurchaseOrderStatusesModel GET /PurchaseOrderStatusModel GET /PurchaseOrderTypesModel GET /PurchaseOrderTypeModel GET /PurchaseOrderModel GET /PurchaseOrderGoodsOwner GET /PurchaseOrderSupplierInfo GET /PurchaseOrderSupplierAddress GET /PurchaseOrderInfo GET /PurchaseOrderStatus GET /PurchaseOrderWarehouse GET /AdvancedPurchaseOrderInfo GET /PurchaseOrderCustomerInfo GET /PurchaseOrderCustomerAddress GET /PurchaseOrderPalletItem GET /PurchaseOrderPalletItemStatus GET /PurchaseOrderFreeValues GET /PurchaseOrderCreatedByUser GET /PurchaseOrderLine GET /PurchaseOrderArticle GET /PurchaseOrderArticleItem GET /PurchaseOrderArticleItemReceivedByUser GET /PurchaseOrderArticleItemPalletItem GET /PurchaseOrderArticleItemPalletItemStatus GET /PurchaseOrderLineFreeValues GET /PurchaseOrderTextLine GET /PurchaseOrderSellerInfo GET /PurchaseOrderClass PATCH /PurchaseOrderLineFreeText1 PATCH /PurchaseOrderLineFreeDecimal1 PATCH /PurchaseOrderLineFreeText2 PATCH /PurchaseOrderReportedNumberOfItemsModel PATCH /PurchaseOrderResponse PATCH /PurchaseOrderFreeText1 ``` -------------------------------- ### Set Classes on Article Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Assigns or updates the classes associated with a specific article using its system ID. Manages the categorization of individual articles. ```REST PUT /api/v1/articles/{articleSystemId}/classes ``` -------------------------------- ### UTC Date Formatting for API Requests Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Illustrates the correct format for sending UTC dates in API requests, including the timezone offset, and how to URL-encode the date string for use in request URLs. ```General 2019-04-09T08:00:00.000+00:00 ``` ```General 2019-04-09T08%3A00%3A00.000%2B00%3A00 ``` ```General GET api/v1/orders?goodsOwnerId=114&shippedTimeFrom=2019-04-09T08%3A00%3A00.000%2B00%3A00 ``` -------------------------------- ### Update Order Warehouse Instruction Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the specific instructions for the warehouse regarding an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/warehouseInstruction ``` -------------------------------- ### Production Order Management Endpoints Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This section covers the endpoints for managing production orders. It includes functionalities to retrieve production order details, status, free values, and line items, as well as posting and patching production order information. ```REST GET /ProductionOrderModel GET /ProductionOrderInfo GET /ProductionOrderStatus GET /ProductionOrderFreeValues GET /ProductionOrderLine GET /ProductionOrderLineArticle GET /ProductionOrderLineConsumedInfo GET /ProductionOrderLineConsumedArticle GET /ProductionOrderLineConsumedPurchaseOrderInfo GET /ProductionOrderLineProducedInfo GET /ProductionOrderLineProducedArticle GET /ProductionOrderLineDisassemblyLine GET /ProductionOrderDisassemblyLine GET /ProductionOrderLineDisassemblyArticle POST /ProductionOrderResponse POST /ProductionOrderModel POST /ProductionOrderFreeValuesModel POST /ProductionOrderLine POST /ProductionOrderLineSpecification POST /ProductionOrderLineSpecificationArticleLine POST /ProductionOrderDisassemblyLine PATCH /ProductionOrderResponse PATCH /ProductionOrderFreeBoolean1 PATCH /ProductionOrderFreeBoolean2 PATCH /ProductionOrderFreeText1 ``` -------------------------------- ### Manage Return Causes - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Provides endpoints to retrieve, create, or update return cause types. It allows fetching all return causes or modifying specific ones using their IDs. ```REST GET /api/v1/returnOrders/returnCauses PUT /api/v1/returnOrders/returnCauses PUT /api/v1/returnOrders/returnCauses/{returnCauseId} ``` -------------------------------- ### Retrieve Goods Owner Information - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Fetches information for a specific goods owner using their ID. ```REST GET /api/v1/goodsOwners/{id} ``` -------------------------------- ### Retrieve Warehouse Information - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Provides endpoints to retrieve details about warehouses, including all warehouses, zones within a warehouse, all zones across warehouses, and location types. ```REST GET /api/v1/warehouses GET /api/v1/warehouses/{warehouseId}/zones GET /api/v1/warehouses/zones GET /api/v1/warehouses/locations/types ``` -------------------------------- ### Create or Update Way of Delivery Type Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new way of delivery type or updates an existing one based on the provided code. ```HTTP PUT /api/v1/orders/wayOfDeliveryTypes ``` -------------------------------- ### Add Order Classes Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Adds specified order classes to an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/addOrderClasses ``` -------------------------------- ### Set Order Classes Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Sets specific order classes for an existing order. Any classes not included in the request will be removed. ```HTTP PATCH /api/v1/orders/{orderId}/setOrderClasses ``` -------------------------------- ### Manage Transporter Contracts Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Retrieves all available transporter contracts for a specific goods owner, including their transporter codes. ```REST GET /api/v1/transporterContracts ``` -------------------------------- ### Update Article Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing article identified by its system ID. This endpoint allows for modification of article details. ```REST PUT /api/v1/articles/{articleSystemId} ``` -------------------------------- ### Update Article Storage Class Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the storage class for a specific article using its system ID. Manages how an article is stored within the warehouse. ```REST PATCH /api/v1/articles/{articleSystemId}/storageClass ``` -------------------------------- ### Create or Update Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new order if one with the specified order number does not exist, or updates an existing order. Orders cannot be updated after warehouse processing has begun. ```HTTP PUT /api/v1/orders ``` -------------------------------- ### Manage Invoices - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Allows retrieval of invoices based on search criteria or by a specific invoice ID. Note that this functionality may require additional API user permissions. ```REST GET /api/v1/invoices GET /api/v1/invoices/{invoiceId} ``` -------------------------------- ### Create Waybill Row for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new waybill row for a specified order. ```HTTP POST /api/v1/orders/{orderId}/wayBillRows ``` -------------------------------- ### Retrieve Warehouse Movements - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Fetches records of physical warehouse movements. ```REST GET /api/v1/movements ``` -------------------------------- ### Create or Update Parcel on Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates a new parcel or updates an existing one on an order. ```HTTP PUT /api/v1/orders/{orderId}/parcels ``` -------------------------------- ### Update Order Return Waybill Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the return waybill details for an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/returnWaybill ``` -------------------------------- ### Update File for Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates a file that is attached to an order. ```HTTP PUT /api/v1/orders/{orderId}/files/{fileId} ``` -------------------------------- ### Update Article File by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates a specific file attached to an article, identified by both article and file IDs. Allows for targeted file modifications. ```REST PUT /api/v1/articles/{articleSystemId}/files/{fileId} ``` -------------------------------- ### Update Order Remark Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the remark or notes associated with an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/orderRemark ``` -------------------------------- ### Create or Update Order Text Lines (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint creates or updates order text lines for a given order. The row number determines if an existing text line is updated or a new one is created. It uses a PUT request. ```REST PUT /api/v1/orders/{orderId}/orderTextLines ``` -------------------------------- ### Update Article Dangerous Goods Info Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the dangerous goods information for an article using its system ID. Requires the UN number to exist in the system. ```REST PUT /api/v1/articles/{articleSystemId}/dangerousGoods ``` -------------------------------- ### Update Order Transporter Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the transporter information for an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/transporter ``` -------------------------------- ### Retrieve Parcel Types - REST API Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Fetches all valid parcel types for a specified goods owner. ```REST GET /api/v1/parcelTypes ``` -------------------------------- ### Update Waybill on Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates or updates the waybill information for an order. ```HTTP PUT /api/v1/orders/{orderId}/orderTracking ``` -------------------------------- ### Update Article Dangerous Goods by Article Number Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the dangerous goods information for an article using its article number. This is an alternative to using the system ID. ```REST PUT /api/v1/articles/dangerousGoods ``` -------------------------------- ### Update Goods Owner Order-ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the Goods Owner Order-ID for an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/goodsOwnerOrderId ``` -------------------------------- ### Update Order Free Text 1 (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the first free text field of an existing order. It requires the order ID. ```REST PATCH /api/v1/orders/{orderId}/freeText1 ``` -------------------------------- ### Update Order Waybill Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the waybill information for an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/waybill ``` -------------------------------- ### Delete Article Storage Class Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Removes the storage class assignment from a specific article using its system ID. Reverts the article to a default or unclassified storage state. ```REST DELETE /api/v1/articles/{articleSystemId}/storageClass ``` -------------------------------- ### Update Parcel Tracking Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Creates or updates tracking information for a specific parcel within an order. ```HTTP PUT /api/v1/orders/{orderId}/parcels/{parcelId}/parcelTracking ``` -------------------------------- ### Update Order Service Point Code Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the service point code associated with an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/servicePointCode ``` -------------------------------- ### Update Order Free Text 2 (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the second free text field of an existing order. It requires the order ID. ```REST PATCH /api/v1/orders/{orderId}/freeText2 ``` -------------------------------- ### Delete All Order Classes Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Removes all order classes from an existing order. ```HTTP DELETE /api/v1/orders/{orderId}/classes ``` -------------------------------- ### Update Order Free Text 3 (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the third free text field of an existing order. It requires the order ID. ```REST PATCH /api/v1/orders/{orderId}/freeText3 ``` -------------------------------- ### Update Order Line Price (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the price of a specific order line. It requires the order ID and the order line ID. ```REST PATCH /api/v1/orders/{orderId}/lines/{orderLineId}/linePrice ``` -------------------------------- ### Update Way of Delivery Type Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing way of delivery type using its unique identifier. ```HTTP PUT /api/v1/orders/wayOfDeliveryTypes/{wayOfDeliveryTypeId} ``` -------------------------------- ### Update Order Line Customer Price (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the customer-specific line price for a particular order line. It requires the order ID and the order line ID. ```REST PATCH /api/v1/orders/{orderId}/lines/{orderLineId}/customerLinePrice ``` -------------------------------- ### Cancel Order by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Cancels an order identified by its unique ID. Cancellation is only possible before the warehouse begins processing the order. ```HTTP DELETE /api/v1/orders/{orderId} ``` -------------------------------- ### Update Order Reported Items to Picked Items (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the reported number of items for each order line to match the picked number of items. It is a PATCH request to the order resource. ```REST PATCH /api/v1/orders/{orderId}/setReportedNumberOfItemsToPickedNumberOfItems ``` -------------------------------- ### Update Order Status Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the status of an order. This operation may fail if goods have already been allocated to the order by the warehouse. ```HTTP PATCH /api/v1/orders/{orderId}/orderStatus ``` -------------------------------- ### Update Order Delivery Date Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the scheduled delivery date for an existing order. ```HTTP PATCH /api/v1/orders/{orderId}/deliveryDate ``` -------------------------------- ### Set Reported Flag on Inventory Adjustment Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Sets the 'reported' flag to true for a specific inventory adjustment related to an article. Used to mark adjustments as processed or reported. ```REST PATCH /api/v1/inventoryAdjustments/{inventoryId}/articles/{articleSystemId}/setReported ``` -------------------------------- ### Update Order Reported Returned Items to Returned Items (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint sets the reported returned number of items on each order line to the actual returned number of items. It is a PATCH request to the order resource. ```REST PATCH /api/v1/orders/{orderId}/setReportedReturnedNumberOfItemsToReturnedNumberOfItems ``` -------------------------------- ### Delete File from Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Deletes a file that is attached to an order. ```HTTP DELETE /api/v1/orders/{orderId}/files/{fileId} ``` -------------------------------- ### Update Waybill Row Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing waybill row for an order. ```HTTP PATCH /api/v1/orders/{orderId}/wayBillRows/{wayBillRowId} ``` -------------------------------- ### Update Parcel on Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing parcel associated with an order. ```HTTP PUT /api/v1/orders/{orderId}/parcels/{parcelId} ``` -------------------------------- ### Update Article Class by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates an existing article class using its unique ID. This operation allows for modification of class properties. ```REST PUT /api/v1/articles/classes/{articleClassId} ``` -------------------------------- ### Update Order Number Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Updates the order number for an existing order. Note: The system does not verify the uniqueness of the new order number. ```HTTP PATCH /api/v1/orders/{orderId}/orderNumber ``` -------------------------------- ### Update Order Freight Price (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the freight price of an existing order. It requires the order ID. ```REST PATCH /api/v1/orders/{orderId}/freightPrice ``` -------------------------------- ### Update Order Line Comment (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the comment associated with a specific order line. It requires the order ID and the order line ID. ```REST PATCH /api/v1/orders/{orderId}/lines/{orderLineId}/comment ``` -------------------------------- ### Update Order Line Reported Returned Items (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint updates the reported returned number of items for a specific order line. It requires the order ID and the order line ID. ```REST PATCH /api/v1/orders/{orderId}/lines/{orderLineId}/reportedReturnedNumberOfItems ``` -------------------------------- ### Update Order Line Reported Items (REST) Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index This endpoint allows updating the reported number of items for a specific order line. It requires the order ID and the order line ID. ```REST PATCH /api/v1/orders/{orderId}/lines/{orderLineId}/reportedNumberOfItems ``` -------------------------------- ### Delete Article Class by ID Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Deletes an article class identified by its ID. This action may affect articles previously assigned to this class. ```REST DELETE /api/v1/articles/classes/{articleClassId} ``` -------------------------------- ### Delete Way of Delivery Type Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Deletes a way of delivery type identified by its unique ID. ```HTTP DELETE /api/v1/orders/wayOfDeliveryTypes/{wayOfDeliveryTypeId} ``` -------------------------------- ### Delete Parcel from Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Deletes a specific parcel from an order. This operation is only permitted if the parcel is empty. ```HTTP DELETE /api/v1/orders/{orderId}/parcels/{parcelId} ``` -------------------------------- ### Delete Waybill Row from Order Source: https://developer.ongoingwarehouse.com/REST/v1/index.html/index Deletes a specific waybill row from an order using its ID. ```HTTP DELETE /api/v1/orders/{orderId}/wayBillRows/{wayBillRowId} ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.