Table of contents
Glossary
Name | Explanation |
offerId | identifier of offer |
GET offer
In order to get information about offer use GET
/api/v1/orderpath/integrations/auth-required/offer using specific ID of this offer. The diagram below shows the dependence of communicating with the API:
Use the parameter in query below to get information about specified offer:
offerId
jsoncurl -X GET "https://api-preprod.one.unity.pl/api/v1/orderpath/integrations/auth-required/offer?offerId=ae19fdd8-dae5-4e23-b78d-8f4faef2b79e" -H "accept: */*" -H "one-tenant: {tenant}" -H "ApiAuth: {apiKey}"
In response you will receive information about offer
Example response:
json{ "clientId": "org:838bed9a-8063-4e4c-93c3-f74b59fcaa5a", "documentNumber": "O/36/1/2022", "expirationDate": "2022-11-15", "id": "15570c28-543e-4928-9466-0d72b015a5f6", "branchId": null, "offerCreatorUser": { "type": "OPERATOR", "id": "7b8cac11-dc09-403d-9737-c14962eb3510", "name": "one-admin", "email": "one-admin@one.unity.pl", "branch": null }, "status": "WON_TRANSFERRED", "notes": [ { "author": { "type": "OPERATOR", "id": "7b8cac11-dc09-403d-9737-c14962eb3510", "name": "one-admin" }, "content": "Test text", "createdOn": "2022-11-08T12:45:01.398696", "id": "fb0c423c-4398-4cc6-8df3-09fd86c1f6ad", "lastModifiedDate": "2022-11-08T12:45:01.398697", "visibleForClients": true, "attachments": [] } ], "paymentMethod": { "id": "96ce3d1c-0aa7-4331-8288-9ae242f9131d", "name": "prepaid", "type": "PREPAID" }, "split": { "slots": [ { "authorizedPersons": [], "availabilityState": "NONE_AVAILABLE", "delivery": { "method": { "id": "82837f86-2aad-446a-a33f-fdd4a22999b1", "name": "Test odbiór w oddziale", "description": "obiór w oddziale", "type": "CROSS_DOCKING", "deliveryDate": "2022-11-09" }, "pickupPointWarehouse": { "id": "WRO-1", "label": "Wrocław stock", "name": "Wrocław" } }, "id": "EMPTY:0", "notes": "", "productLines": [ { "id": "4bbecd33-ccf9-4dd8-b45d-14addb2982d5", "price": { "additionalCosts": [ { "prices": { "gross": 113.16, "net": 92, "tax": 21.16 }, "type": "weee_surcharge" } ], "base": { "gross": 2000, "net": 2000, "tax": 0 }, "discount": { "fixed": 1180, "percent": 59 }, "item": { "gross": 820, "net": 820, "tax": 0 }, "line": { "gross": 1640, "net": 1640, "tax": 0 }, "margin": { "fixed": 0, "percent": 0 }, "purchase": { "gross": 820, "net": 820, "tax": 0 }, "taxRate": 0 }, "product": { "brand": { "description": "test brand", "id": "testbranname", "name": "test bran name" }, "canonicalCategory": "kategoria2", "characteristics": [], "id": "product4111", "labels": [ "Ecommerce" ], "manufacturer": { "id": "manu123", "name": "manufactura" }, "manufacturerIndex": "manu123", "measurementUnits": { "contentUnitCode": "pack", "contentUnitDescription": "pack", "orderUnitCode": "pack123", "orderUnitDescription": "pack", "packingQuantity": 2, "quantityInterval": 2, "quantityMin": 2 }, "name": "test name", "status": "ACTIVE" }, "contentQuantity": { "value": 4, "type": "CONTENT_QUANTITY" }, "orderQuantity": { "value": 2, "type": "ORDER_QUANTITY" }, "notes": [] } ], "supplyWarehouse": { "id": "WRO", "label": "Wrocław warehouse", "name": "Wrocław" }, "totalPrice": { "additionalCosts": [ { "prices": { "gross": 113.16, "net": 92, "tax": 21.16 }, "type": "weee_surcharge" } ], "delivery": { "gross": 0, "net": 0, "tax": 0 }, "margin": { "fixed": 0, "percent": 0 }, "products": { "gross": 1640, "net": 1640, "tax": 0 }, "total": { "gross": 1753.16, "net": 1732, "tax": 21.16 } } } ] }, "prices": { "additionalCosts": [ { "prices": { "gross": 113.16, "net": 92, "tax": 21.16 }, "type": "weee_surcharge" } ], "delivery": { "gross": 0, "net": 0, "tax": 0 }, "margin": { "fixed": 0, "percent": 0 }, "payment": { "gross": 0, "net": 0, "tax": 0 }, "products": { "gross": 1640, "net": 1640, "tax": 0 }, "total": { "gross": 1753.16, "net": 1732, "tax": 21.16 } }, "attachments": [ { "id": "bd117243-f4cb-454d-b706-8585d84fee09", "fileName": "cb7cb79fcb864360a8e830b68a1c742c-co2.jpg" } ] }