### Retrieve Offers GET Request Example Source: https://developer.octopia-io.net/api-reference/offer-management/retrieve-offers Example GET request to retrieve offers, including query parameters for sales channel ID and expansion. This feature is currently only available on Cdiscount. ```http GET /offers?salesChannelId=CDISFR&expand=salesChannelFeedback ``` -------------------------------- ### Retrieve Packages with Pagination Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json Example GET request to retrieve offer packages with a specified limit for pagination. ```http GET /offer-packages?limit=10 ``` -------------------------------- ### Retrieve Offers with Competing Data Example Source: https://developer.octopia-io.net/api-reference/offer-management/retrieve-offers Example GET request to retrieve offers, specifically including competing offer data for a given sales channel. ```http GET /offers?salesChannelId=CDISFR&fields=salesChannelFeedback.competingOffers ``` -------------------------------- ### Retrieve Package by ID Request Example Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json Example of how to send a GET request to retrieve package information using the packageId. Ensure to include the SellerId in the headers. ```http GET /offer-packages/{packageId} HTTP/1.1 Host: api.octopia-io.net SellerId: 98979 ``` -------------------------------- ### Download Invoice Document Request Example Source: https://developer.octopia-io.net/api-reference/manage-financial-data Example of a GET request to download the PDF of a specific invoice. Requires SellerId in headers and invoiceId in the path. ```http GET /invoices/1400178408/documents ``` -------------------------------- ### Check Offer Package Status Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-xml This example shows how to construct a GET request to check the status of a submitted offer package using its packageId. This is essential for detecting integration issues. ```http GET /offer-integration-packages/424325363619 ``` -------------------------------- ### Retrieve Packages by State Filter Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json Example GET request to retrieve offer packages filtered by their current state. ```http GET /offer-packages?state=WaitingForCompletion ``` ```http GET /offer-packages?state=Ready ``` ```http GET /offer-packages?state=IntegrationPending ``` ```http GET /offer-packages?state=Integrated ``` ```http GET /offer-packages?state=Rejected ``` -------------------------------- ### POST /products-integration Endpoint Example Source: https://developer.octopia-io.net/api-reference/product-management This is an example of how to submit products into a new package using JSON data to the /products-integration endpoint. ```http POST /products-integration Submit products into a new package with JSON data Use this API to integrate your products on Octopia * * * **Functional Rules:** * Octopia accepts products in English, French and Spanish. The values accepted for the language field are en-US, fr-FR, and es-ES. * **Only products with fr-FR language will be available for Cdiscount** * This process is asynchronous, check the integration results using the packageId provided in the API response and the API: * **GET** `/products-integration-reports` * If you are creating a standard product: * Use gtin attribute only * If you are creating a variant product: * Use GTIN field to determine the public identifier of the product * Use variantGroupReference field to determine the parent product linking a variant family * If you want to add an associated file on an authorized property, make sure that: * The file doesn't exceed 1Mo * The file respect the expected format (pdf/jpg/...etc). You can get this information by consulting the route properties/{reference} * The file is provided via URL format The number of items cannot be more than the following limit **_(min: 1 / max: 10 000)_** _Endpoint full URL:_ https://api.octopia-io.net/seller/v2/products-integration ``` -------------------------------- ### Pagination Headers Example Source: https://developer.octopia-io.net/api-reference/manage-financial-data Example of Link header values for navigating paginated results. ```text Link: ; rel="first", ; rel="prev", ; rel="next" ``` -------------------------------- ### Product Data Request Body Example Source: https://developer.octopia-io.net/api-reference/fulfillment-management/ffm-inbound Example of a request body for product data, including details like GTIN, dimensions, and value. ```json { "gtin": "0697691193670", "label": "MORPILOT Sac de transport chien chat", "sellerId": 12345, "sellerProductReference": "5291030-cd", "productCondition": "New", "dimensionMinimum": 5, "dimensionMedium": 10, "dimensionMaximum": 100, "weight": 12, "categoryUn": "1234", "categoryIcpe": "1234", "hasExpirationDate": true, "traceability": "SerialNumber", "customsReference": "1234.56.78", "productValue": 5, "originCountryCode": "FR", "language": "fr-FR" } ``` -------------------------------- ### Retrieve Packages by Sales Channel Filter Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json Example GET request to retrieve offer packages filtered by a specific sales channel ID. ```http GET /offer-packages?salesChannelId=SELLZZ ``` -------------------------------- ### Create Discussion Request Body Example Source: https://developer.octopia-io.net/api-reference/discussions-management Example of a request body used to create a new discussion. Ensure subject is 5-50 characters and message body is 13-5000 characters. Avoid duplicate discussions by checking existing ones via GET /discussions. ```json { "subject": "Broken product", "orderId": "SALESC123456789", "salesChannel": "SALESC", "subtypologyCode": "broken-product", "productId": "pm5972a", "message": { "body": "product received is broken", "receiver": "Customer" } } ``` -------------------------------- ### Retrieve All Carriers Endpoint Example Source: https://developer.octopia-io.net/api-reference/seller-information Example request to retrieve all supported carriers. This endpoint requires the SellerId in the header. ```http GET /carriers ``` -------------------------------- ### Retrieve Cancellation Reasons Example Source: https://developer.octopia-io.net/api-reference/orders-management Example of how to retrieve cancellation reasons for shipped orders. Ensure the SellerId is provided in the headers. ```http GET /cancellation-reasons?salesChannel=SELLZZ&userType=Seller&orderStatus=Shipped Host: api.octopia-io.net SellerId: 98979 ``` -------------------------------- ### Get Discussion Details Endpoint Example Source: https://developer.octopia-io.net/api-reference/discussions-management Example of how to retrieve full discussion details using the discussion ID. Requires SellerId in the header. ```http GET /discussions/21554654retregf6548 HTTP/1.1 Host: api.octopia-io.net SellerId: 98979 ``` -------------------------------- ### Retrieve Categories Endpoint Example Source: https://developer.octopia-io.net/api-reference/product-management Example of a GET request to retrieve categories. The Accept-Language header can be used to specify the desired language for category labels. ```http GET /categories ``` -------------------------------- ### Retrieve Delivery Note Endpoint Example Source: https://developer.octopia-io.net/api-reference/fulfillment-management/ffm-inbound Example of a GET request to retrieve the inbound delivery note using the shipment's unique identifier. ```http GET /inbound-shipments/b072c529-a894-456c-ab23-f434321fab69/delivery-notes ``` -------------------------------- ### Create or Full Offer Update (XML) Source: https://developer.octopia-io.net/api-reference/offer-management/management-rules Sample XML for creating a new offer or performing a full update. Requires OfferPackage to be set to PackageType='Full'. ```xml < OfferPackage.Offers > < OfferCollection Capacity="1" > < Offer ProductEan="12345678901231" SellerProductId="YourInternalReference" Price="27.3" StrikedPrice="29.90" EcoPart="0.50" Vat="20" DeaTax="0.10" PriceMustBeAligned="true" MinimumPriceForAlignment="22.50" Stock="1337" ProductPackagingUnit="Piece" ProductPackagingValue="1" PreparationTime="3" > < Offer.ShippingInformationList > < ShippingInformationList Capacity="1" > < ShippingInformation DeliveryMode="Tracked" ShippingCharges="3.50" AdditionalShippingCharges="0.50" /> < /ShippingInformationList > < /Offer.ShippingInformationList > < /Offer > < /OfferCollection > < /OfferPackage.Offers > ``` -------------------------------- ### Example JSON Schema for List of Packages Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json This JSON schema represents a successful response when listing offer packages. It includes pagination information and a list of individual offer package details. ```json { "itemsPerPage": 2, "items": [ { "offerRequestCount": 1000, "packageId": "AAA0000001", "state": "Integrated", "type": "Upsert", "salesChannelId": "SELLZZ", "submissionDate": "2019-10-15T08:28:08.0000000+00:00" }, { "offerRequestCount": 1000, "packageId": "AAA0000002", "state": "Integrated", "type": "Upsert", "salesChannelId": "SELLZZ", "submissionDate": "2019-10-16T08:28:08.0000000+00:00", "result": { "message": "Vous gérez désormais vos offres manuellement sur ce canal de vente.", "resultCode": "2394" } } ] } ``` -------------------------------- ### Example Offer Creation Request Body Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json This JSON object represents a sample request body for creating offers. It includes details for multiple products, specifying seller references, product information, condition, pricing with taxes, and delivery modes. ```json [ { "sellerExternalReference": "SellerRef001", "product": { "gtin": "1234567890000", "reference": "AUC1234567890000" }, "condition": "New", "price": { "price": 49.99, "originPrice": 59.99, "taxes": [ { "code": "VAT", "value": 20 }, { "code": "DeaTax", "value": 1 }, { "code": "EcoTax", "value": 1 } ] }, "deliveryModes": [ { "code": "THD", "cost": 1.99, "additionalCost": 2.99 }, { "code": "EHD", "cost": 3.99, "additionalCost": 4.99 } ], "preparationTime": 4, "quantity": 100 }, { "sellerExternalReference": "SellerRef002", "product": { "gtin": "1234567890002", "reference": "AUC1234567890002" }, "condition": "New", "price": { "price": 19.99, "originPrice": 29.99, "taxes": [ { "code": "VAT", "value": 20 }, { "code": "DeaTax", "value": 1 }, { "code": "EcoTax", "value": 1 } ] }, "deliveryModes": [ { "code": "THD", "cost": 1.99, "additionalCost": 2.99 }, { "code": "EHD", "cost": 3.99, "additionalCost": 4.99 } ], "preparationTime": 2, "quantity": 50 } ] ``` -------------------------------- ### Retrieve Seller Addresses Endpoint Source: https://developer.octopia-io.net/api-reference/seller-information Example of how to call the GET /sellers/addresses endpoint to retrieve a seller's addresses. Requires the SellerId header. ```http GET /sellers/addresses ``` -------------------------------- ### Example Financial Operations Response Source: https://developer.octopia-io.net/api-reference/manage-financial-data This JSON structure represents the response from a GET /operations request, detailing sales, VAT, commissions, and the final payout amount for an order. ```json { "items": [ { "operationReference": "1601302358PGI56", "orderStatus": "Accepted", "paidAt": "2025-09-11", "eventTypes": ["Sale", "Commission", "VAT"], "sale": { "productAmount": 100.00, "shippingFeesAmount": 5.00, "processingFeesAmount": 1.00, "total": 106.00 }, "vatSale": { "salesVatAmount": 20.00, "salesShippingCostVatAmount": 1.00, "salesTotalVatAmount": 21.00 }, "commission": 10.00, "commissionDetail": [ {"type": "product", "amount": 7.00}, {"type": "paymentFees", "amount": 3.00} ], "totalAmount": 96.00 } ] } ``` -------------------------------- ### XML Structure for Offers Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-xml This is a sample XML structure for offer data. Ensure your 'offers.xml' file follows this format, including all required fields. ```xml ``` -------------------------------- ### Retrieve Return Label Example Source: https://developer.octopia-io.net/api-reference/fulfillment-management/ffm-return This example demonstrates how to retrieve the label for a specific return using its ID. Ensure the return has an associated customer return label and that the SellerId header is provided. ```http GET /returns/abbf3123-f914-42d9-ab98-886e731672a5/label ``` -------------------------------- ### Refunded Order Example Source: https://developer.octopia-io.net/api-reference/manage-financial-data This example illustrates the structure of a refunded order record. ```APIDOC ## Refunded Order ### Description Represents a refunded order, detailing the original sale information and the refund amounts. ### Response #### Success Response (200) - **itemsPerPage** (integer): Number of items per page. - **common** (object): - **totalAmount** (number): Total amount for all operations. - **items** (array): - **operationReference** (string): Reference for the order. - **orderStatus** (string): Status of the order (e.g., Sent). - **createdAt** (string): Date the financial operation was created. - **lastChangeDate** (string): Date of the last change to the operation. - **acceptedAt** (string): Date the order was accepted. - **shippedAt** (string): Date the order was shipped. - **paidAt** (string): Date the order was paid. - **refundedAt** (string): Date the order was refunded. - **releasePaymentDate** (string): Date the payment becomes available. - **paymentState** (string): Status of the payment (e.g., Paid). - **refund** (object): - **productAmount** (number): Refunded product amount. - **shippingFeesAmount** (number): Refunded shipping fees amount. - **processingFeesAmount** (number): Refunded processing fees amount. - **total** (number): Total refunded amount. - **vatRefund** (object): - **refundVatAmount** (number): VAT amount refunded. - **refundShippingCostVatAmount** (number): VAT amount refunded for shipping costs. - **refundTotalVatAmount** (number): Total VAT amount refunded. - **creditOnCommission** (number): Credit applied on commission. - **previsionalDateBankTransfer** (boolean): Indicates if the bank transfer date is provisional. - **totalAmount** (number): Total amount for this operation. - **currency** (string): Currency of the operation. - **invoiceId** (string): ID of the invoice. - **salesChannel** (string): Channel through which the sale occurred. - **eventTypes** (array): Types of events associated with the operation. ### Response Example ```json { "itemsPerPage": 1, "common": { "totalAmount": -109.05 }, "items": [ { "operationReference": "2101011234THLDJ", "orderStatus": "Sent", "createdAt": "2021-08-01", "lastChangeDate": "2021-08-16", "acceptedAt": "2021-08-02", "shippedAt": "2021-08-07", "paidAt": "2021-08-15", "refundedAt": "2025-05-15", "releasePaymentDate": "2021-08-05", "paymentState": "Paid", "refund": { "productAmount": -112.92, "shippingFeesAmount": -5.43, "processingFeesAmount": -2.81, "total": -121.16 }, "vatRefund": { "refundVatAmount": 15, "refundShippingCostVatAmount": 1.2, "refundTotalVatAmount": 16.5 }, "creditOnCommission": 9.66, "previsionalDateBankTransfer": false, "totalAmount": -109.05, "currency": "EUR", "invoiceId": "", "salesChannel": "Cdiscount France", "eventTypes": [ "Refund", "CommissionRestitution" ] } ] } ``` ``` -------------------------------- ### Full Offer Creation or Update Source: https://developer.octopia-io.net/api-reference/offer-management/management-rules Example of an XML structure for creating a new offer or performing a full update, requiring PackageType to be 'Full'. ```APIDOC ## Creation or full offer update **Requires** `OfferPackage` **to be set to** `PackageType=”Full”` ```xml < OfferPackage.Offers > < OfferCollection Capacity="1" > < Offer ProductEan="12345678901231" SellerProductId="YourInternalReference" Price="27.3" StrikedPrice="29.90" EcoPart="0.50" Vat="20" DeaTax="0.10" PriceMustBeAligned="true" MinimumPriceForAlignment="22.50" Stock="1337" ProductPackagingUnit="Piece" ProductPackagingValue="1" PreparationTime="3" > < Offer.ShippingInformationList > < ShippingInformationList Capacity="1" > < ShippingInformation DeliveryMode="Tracked" ShippingCharges="3.50" AdditionalShippingCharges="0.50" /> < /ShippingInformationList > < /Offer.ShippingInformationList > < /Offer > < /OfferCollection > < /OfferPackage.Offers > ``` ``` -------------------------------- ### Retrieve Previous Gesture Example Source: https://developer.octopia-io.net/api-reference/orders-management Example of how to retrieve a paginated list of commercial gesture requests for a specific order using a cursor. The default sort is descending on `updatedAt`. ```http /order-commercial-gesture-requests?orderId=01210525142759UT8E&cursor=c29ydDpkZXNjJmluY2x1ZGVfaXRlbT10cnVlJmlkPTE2ODIwNzA2Mzk= ``` -------------------------------- ### Security Deposit Example Source: https://developer.octopia-io.net/api-reference/manage-financial-data This example shows the structure for a security deposit financial record. ```APIDOC ## Security Deposit ### Description Represents a security deposit transaction, typically related to services or guarantees. ### Response #### Success Response (200) - **itemsPerPage** (integer): Number of items per page. - **common** (object): - **totalAmount** (number): Total amount for all operations. - **items** (array): - **operationReference** (string): Reference for the security deposit or related invoice. - **orderStatus** (string): Status of the order, often 'None' for deposits. - **createdAt** (string): Date the financial operation was created. - **shippedAt** (string): Date associated with the deposit, possibly when funds were allocated. - **lastChangeDate** (string): Date of the last change to the operation. - **paidAt** (string): Date the deposit was paid. - **paymentState** (string): Status of the payment (e.g., Paid). - **serviceFinancialFlow** (number): The amount related to the service financial flow. - **previsionalDateBankTransfer** (boolean): Indicates if the bank transfer date is provisional. - **totalAmount** (number): Total amount for this operation. - **currency** (string): Currency of the operation. - **invoiceId** (string): ID of the invoice associated with the deposit. - **salesChannel** (string): Channel related to the deposit. - **eventTypes** (array): Types of events associated with the operation (e.g., SecurityDeposit). ### Response Example ```json { "itemsPerPage": 1, "common": { "totalAmount": 753.82 }, "items": [ { "operationReference": "Avoir de garantie - 1700000000", "orderStatus": "None", "createdAt": "2025-04-28", "shippedAt": "2025-04-28", "lastChangeDate": "2025-05-03", "paidAt": "2025-05-02", "paymentState": "Paid", "serviceFinancialFlow": 753.82, "previsionalDateBankTransfer": false, "totalAmount": 753.82, "currency": "EUR", "invoiceId": "1700000000", "salesChannel": "Cdiscount France", "eventTypes": [ "SecurityDeposit" ] } ] } ``` ``` -------------------------------- ### Product Schema Example Source: https://developer.octopia-io.net/api-reference/product-management This JSON schema represents a successful response for product data, detailing fields like GTIN, references, descriptions, attributes, and status. ```json { "itemsPerPage": 10, "items": [ { "gtin": "1234567890128", "gtinReference": "8210987654321", "variantGroupReference": "Ref8210987654321", "productReference": "AAAAA00148", "sellerProductReference": "AGRA39401", "title": "My title", "description": "My description", "richMarketingDescription": "My marketing description", "brand": "My brand", "categoryCode": "010201", "language": "fr-FR", "attributes": [ { "files": [ "https://media.pdf" ], "propertyReference": "24077", "values": [ "Electrique", "Batterie" ] } ], "createdAt": "2022-01-14T07:35:19.0000000+00:00", "updatedAt": "2021-03-28T08:32:30.0000000+00:00", "integratedProductId": "4fdaza6s-4557-3364-sqd4-45qsdq441sqc", "packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sellerId": 98979, "submissionDate": "2022-05-24T07:38:39.0000000+00:00", "submissionType": "Excel", "status": "Validated", "operationType": "Modification", "sellerPictureUrls": [ { "index": 1, "url": "https://static.education.francetv.fr/media/img/hd/img.gif" } ], "integrationPictureUrls": [ { "index": 1, "url": "https://static.education.francetv.fr/media/img/hd/img.gif" } ], "publicationCompleteness": 30, "wasMarketable": false, "wasAllowedToEdit": true, "wasAllowedToEnrich": true, "errors": [ { "code": "IncorrectValue", "field": "CategoryReference", "message": "Le champ doit contenir au moins une valeur correcte", "type": "Exports" } ], "warnings": [ { "code": "IncorrectValue", "field": "CategoryReference", "message": "Le champ doit contenir au moins une valeur correcte", "type": "Exports" } ], "infos": [ { "code": "IncorrectValue", "field": "CategoryReference", "message": "Le champ doit contenir au moins une valeur correcte", "type": "Exports" } ] } ] } ``` -------------------------------- ### Sales Operation Example Source: https://developer.octopia-io.net/api-reference/manage-financial-data This example demonstrates the structure of a successful sales operation record. ```APIDOC ## Sales Operation ### Description Represents a successful sales transaction, including details about the order, payment, and associated commissions. ### Response #### Success Response (200) - **itemsPerPage** (integer): Number of items per page. - **common** (object): - **totalAmount** (number): Total amount for all operations. - **items** (array): - **operationReference** (string): Reference for the order. - **orderStatus** (string): Status of the order (e.g., Accepted, Sent). - **createdAt** (string): Date the financial operation was created. - **lastChangeDate** (string): Date of the last change to the operation. - **acceptedAt** (string): Date the order was accepted. - **shippedAt** (string): Date the order was shipped. - **paidAt** (string): Date the order was paid. - **releasePaymentDate** (string): Date the payment becomes available. - **paymentState** (string): Status of the payment (e.g., Paid, Estimated). - **sale** (object): - **productAmount** (number): Gross product amount including VAT. - **shippingFeesAmount** (number): Gross shipping fees including VAT. - **processingFeesAmount** (number): Gross processing fees including VAT. - **total** (number): Gross total sale amount including VAT. - **vatSale** (object): - **salesVatAmount** (number): VAT amount for sales. - **salesShippingCostVatAmount** (number): VAT amount for shipping costs. - **salesTotalVatAmount** (number): Total VAT amount for the sale. - **commission** (number): Commission amount. - **commissionsDetail** (array): Details of commissions. - **previsionalDateBankTransfer** (boolean): Indicates if the bank transfer date is provisional. - **totalAmount** (number): Total amount for this operation. - **currency** (string): Currency of the operation. - **invoiceId** (string): ID of the invoice. - **salesChannel** (string): Channel through which the sale occurred. - **eventTypes** (array): Types of events associated with the operation. ### Response Example ```json { "itemsPerPage": 1, "common": { "totalAmount": 109.05 }, "items": [ { "operationReference": "2101011234THLDJ", "orderStatus": "Accepted", "createdAt": "2021-08-01", "lastChangeDate": "2021-08-12", "acceptedAt": "2021-08-02", "shippedAt": "2021-08-07", "paidAt": "2021-08-11", "releasePaymentDate": "2021-08-05", "paymentState": "Paid", "sale": { "productAmount": 112.92, "shippingFeesAmount": 5.43, "processingFeesAmount": 2.81, "total": 121.16 }, "vatSale": { "salesVatAmount": -15, "salesShippingCostVatAmount": -1.2, "salesTotalVatAmount": -16.5 }, "commission": -9.66, "commissionsDetail": [ { "type": "product", "amount": -5.41 }, { "type": "commission4x", "amount": -1.44 }, { "type": "interetBca", "amount": -2.81 } ], "previsionalDateBankTransfer": false, "totalAmount": 109.05, "currency": "EUR", "invoiceId": "1900000000", "salesChannel": "Cdiscount France", "eventTypes": [ "Sale", "Commission" ] } ] } ``` ``` -------------------------------- ### Price, Quantity, and Delivery Update JSON Example Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json Update price, quantity, delivery modes, and preparation time for offers using this JSON format. `sellerExternalReference` is mandatory for each offer. ```json [ { "sellerExternalReference": "SellerRef001", "price": { "price": 49.99 }, "quantity": 20, "deliveryModes": [ { "code": "THD", "cost": 1.99, "additionalCost": 2.99 }, { "code": "EHD", "cost": 3.99, "additionalCost": 4.99 } ], "preparationTime": 4 }, { "sellerExternalReference": "SellerRef002", "price": { "price": 19.99 }, "quantity": 10, "deliveryModes": [ { "code": "THD", "cost": 1.99, "additionalCost": 2.99 }, { "code": "EHD", "cost": 3.99, "additionalCost": 4.99 } ], "preparationTime": 2 } ] ``` -------------------------------- ### 403 Forbidden Example Source: https://developer.octopia-io.net/api-reference/product-management Example of a 403 Forbidden response, indicating the server understood the request but refuses to authorize it. ```json { "statusCode": 403, "title": "Forbidden", "traceId": "00-6acce9a525266bc5a6ede8e335a616dc-0021a57d87e40fae-00", "type": "https://tools.ietf.org/html/rfc7231" } ``` -------------------------------- ### Retrieve Category Properties Endpoint Example Source: https://developer.octopia-io.net/api-reference/product-management Example of how to call the endpoint to retrieve properties for a specific category. ```http GET /categories/010H0R/properties ``` -------------------------------- ### Mark a Package as Ready Source: https://developer.octopia-io.net/api-reference/offer-management/offer-management-json This endpoint submits a package for integration by changing its state to 'Ready'. Once submitted, no further uploads are possible, and the package will be processed asynchronously. ```APIDOC ## PATCH /offer-packages/{packageId} ### Description Submits a package for integration by changing its state to `Ready`. This action is irreversible, and the package will be processed asynchronously. ### Method PATCH ### Endpoint `/offer-packages/{packageId}` ### Parameters #### Path Parameters - **packageId** (string) - Required - The package identifier. Example: `AAA0000001` #### Headers - **SellerId** (string) - Required - Octopia Seller Identifier. Example: `98979` #### Request Body - **state** (string) - Required - Must be set to `"Ready"`. ### Request Example ```json { "state": "Ready" } ``` ### Response #### Success Response (200) This endpoint does not explicitly define a success response body in the provided documentation. However, a successful request implies the package state has been updated. #### Error Response (e.g., 400, 404, 500) - **type** (uri) - A URI reference that identifies the problem type. - **status** (integer) - The HTTP status code. - **instance** (string) - A URI reference that identifies the specific occurrence of the problem. - **title** (string) - A short human-readable summary of the problem type. - **traceId** (string) - The response identifier. - **detail** (string) - A human-readable explanation specific to this occurrence of the problem. ### Error Response Example (500 Internal Server Error) ```json { "type": "https://tools.ietf.org/html/rfc7231", "status": 500, "instance": "/path-example", "title": "Internal Server Error", "traceId": "00-9055d0e39a4a5554866eee202737812f-8e3fb58dea31a710-00" } ``` ```