02 listopada 2017
Usługi dodatkowe
Udostępniliśmy naszym sprzedającym usługi dodatkowe w Allegro. Usługami dodatkowymi są np.: zapakowanie na prezent, wniesienie, montaż itp. Sprzedawca może dodać usługi dodatkowe w swoich ofertach.
Dla usług dodatkowych przygotowaliśmy nowe zasoby w Allegro REST API
- GET /sale/offer-additional-services/definitions?user.id={Seller_ID} - chcę pobrać listę dostępnych usług dodatkowych.
- POST /sale/offer-additional-services/groups - chcę dodać nową grupę usług dodatkowych.
- PUT /sale/offer-additional-services/groups/{groupId} - chcę edytować daną grupę usług dodatkowych.
- GET /sale/offer-additional-services/groups?user.id={Seller_ID} - chcę pobrać swoją listę grup z dostępnymi usługami dodatkowymi .
- GET /sale/offer-additional-services/groups/{groupId} - chcę pobrać konkretną grupę usług dodatkowych na podstawie identyfikatora.
GET /sale/offer-additional-services/definitions
To zasób, którym pobierzesz listę dostępnych usług dodatkowych dla danego użytkownika.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/offer-additional-services/definitions?user.id={userId}'
-H 'authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json' \
Przykładowy response:
{
"definitions": [
{
"id": "GIFT_WRAP", -- identyfikator usługi dodatkowej
"name": "Zapakuj na prezent", -- nazwa usługi dodatkowej
"description": "Zapakuj na prezent", -- opis usługi dodatkowej
"availableConstraints": [ -- ograniczenia usługi dodatkowej
{
"type": "COUNTRY_SAME_QUANTITY" -- ograniczenie ilości
usług dodatkowych,
tzn. liczba usług dodatkowych
musi być równa liczbie
kupionych przedmiotów.
Ograniczenie dotyczy usługi
Zapakuj na prezent (GIFT_WRAP).
}
],
"updatedAt": "2017-08-04T10:24:47.659Z"
},
{
"id": "CARRY_IN",
"name": "Wniesienie na dowolne piętro",
"description": "Wniesienie na dowolne piętro",
"availableConstraints": [
{
"type": "COUNTRY_DELIVERY_SAME_QUANTITY", -- ograniczenie ilości usług
dodatkowych i formy wysyłki.
Liczba usług dodatkowych musi
być równa liczbie kupionych
przedmiotów. Ponadto usługi
są dostępne tylko przy
określonych metodach wysyłki
"availableDeliveryMethods": [ -- formy wysyłki dostępne dla
danej usługi dodatkowej
(więcej informacji znajdziesz
na [końcu artykułu](#6)).
"7203cb90-864c-4cda-bf08-dc883f0c78ad",
"45309171-0415-49cd-b2cf-89e9143d20f0",
"2b6ca59d-1e4c-426c-82a9-efcbd730846b",
"74bc07eb-552f-4581-b68c-da46716d4a9a",
"ffb2643b-4b90-4925-9d29-0d93ad9488a6"
]
}
],
"updatedAt": "2017-08-04T10:24:48.772Z"
},
{
"id": "INSTALLATION",
"name": "Montaż",
"description": "Montaż",
"availableConstraints": [
{
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"availableDeliveryMethods": [
"7203cb90-864c-4cda-bf08-dc883f0c78ad",
"45309171-0415-49cd-b2cf-89e9143d20f0"
]
}
],
"updatedAt": "2017-08-04T10:24:49.120Z"
}
]
}
POST /sale/offer-additional-services/groups
Tym zasobem dodasz nową grupę usług dodatkowych. Musisz byc zalogowany jako sprzedawca.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/sale/offer-additional-services/groups' \
-H 'authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json’ \
-H 'content-type: application/vnd.allegro.public.v1+json' \
-d '{
"name": "nazwa grupy", -- wymagane, nazwa nowej grupy usług
dodatkowych
"additionalServices": [ -- wymagane, typy usług dodatkowych
dostępnych w ramach danej grupy
{
"definition": {
"id": "CARRY_IN" -- wymagane, dostępne wartości:
dostępną listę wartości
pobierzesz zasobem
GET /sale/offer-additional-services
/definitions?user.id={Seller_ID}
},
"description": "opis usługi dodatkowej", -- wymagane, opis usługi dodatkowej
"configurations": [ -- wymagane, cena danej
usługi dodatkowej
{
"price": {
"amount": "49.99",
"currency": "PLN"
},
"constraintCriteria": { -- wymagane, ograniczenia danej usługi
dodatkowej
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [ -- wymagane dla typu
COUNTRY_DELIVERY_SAME_QUANTITY,
niewymagane dla
COUNTRY_SAME_QUANTITY;
przypisane metody dostawy danej
usługi dodatkowej
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"} -- wymagene, identyfikator danej
metody dostawy (więcej informacji
znajdziesz na [końcu artykułu](#6)).
]
}
}
]
}
]
}'
Przykładowy response:
{
"id": "0aba7cf9-8896-44a4-8919-266bf6516a82", -- identyfikator utworzonej
grupy usług dodatkowych
"name": "nazwa grupy", -- nazwa utworzonej grupy
usług dodatkowych
"seller": {
"id": "53703086" -- identyfikator sprzedawcy
},
"additionalServices": [ -- kryteria, które opisują
warunki wybranej grupy
usług dodatkowych. np. cena
{
"definition": {
"id": "CARRY_IN"
},
"description": "opis usługi dodatkowej",
"configurations": [
{
"price": {
"amount": "49.99",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"}
]
}
}
]
}
],
"createdAt": "2017-10-04T11:41:30.904Z",
"updatedAt": "2017-10-04T11:41:30.905Z"
}
PUT /sale/offer-additional-services/groups/{groupId}
Tym zasobem możesz zaktualizować dane wybranej grupy usług dodatkowych.
Przykładowy request:
curl -X PUT \
'https://api.allegro.pl/sale/offer-additional-services/groups/{groupId}' \
-H 'authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json’ \
-H 'content-type: application/vnd.allegro.public.v1+json' \
-d '{
"name": "nowa nazwa grupy",
"additionalServices": [
{
"definition": {
"id": "CARRY_IN"
},
"description": "nowy opis usługi dodatkowej",
"configurations": [
{
"price": {
"amount": "49.99",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"}
]
}
}
]
}
]
}'
Przykładowy response:
{
"id": "0aba7cf9-8896-44a4-8919-266bf6516a82",
"name": "nowa nazwa grupy",
"seller": {
"id": "53703086"
},
"additionalServices": [
{
"definition": {
"id": "CARRY_IN"
},
"description": "nowy opis usługi dodatkowej",
"configurations": [
{
"price": {
"amount": "49.99",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"}
]
}
}
]
}
],
"createdAt": "2017-10-04T11:41:30.904Z",
"updatedAt": "2017-10-04T12:00:51.929Z"
}
GET /sale/offer-additional-services/groups?user.id={Seller_ID}
Tym zasobem otrzymasz listę grup z usługami dodatkowymi dostępnymi dla danego użytkownika, które możesz przypisać do ofert poprzez WebAPI. Aby to zrobić uzupełnij strukturę additionalServicesGroup, którą udostępniliśmy w parametrach wejściowych w metodach:
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/offer-additional-services/groups?user.id={userId}' \
-H 'authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json’ \
Przykładowy response:
{
"additionalServicesGroups": [ -- konfiguracja tablica z
grupami usług dodatkowych
{
"id": "8603fbbb-0f0e-4999-945e-258c4c96c7d6", -- identyfikator danej grupy
usług dodatkowych
"name": "Mój pakiet usług", -- nazwa danej grupy
usług dodatkowych
"seller": { -- identyfikator sprzedawcy
"id": "53703086"
},
"additionalServices": [ -- tablica usług dodatkowych
w danej grupie
{
"definition": {
"id": "GIFT_WRAP"
},
"description": "Zapakuj na prezent",
"configurations": [ -- konfiguracja danej
usługi dodatkowej
{
"price": {
"amount": "20",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_SAME_QUANTITY",
"country": "PL"
}
}
]
},
{
"definition": {
"id": "CARRY_IN"
},
"description": "Wniesienie na dowolne piętro",
"configurations": [
{
"price": {
"amount": "22",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"},
{"id": "4dd9c904-e892-4649-bdec-5454d6b53d28"},
{"id": "f7e952b5-9ae8-40a9-90dd-e71ab9da29dd"},
{"id": "5d9c7838-e05f-4dec-afdd-58e884170ba7"}
]
}
}
]
},
{
"definition": {
"id": "INSTALLATION"
},
"description": "Montaż",
"configurations": [
{
"price": {
"amount": "25",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"},
{"id": "4dd9c904-e892-4649-bdec-5454d6b53d28"},
{"id": "f7e952b5-9ae8-40a9-90dd-e71ab9da29dd"},
{"id": "ffb2643b-4b90-4925-9d29-0d93ad9488a6"},
{"id": "74bc07eb-552f-4581-b68c-da46716d4a9a"}
]
}
}
]
}
],
"createdAt": "2017-08-07T12:08:36.151Z",
"updatedAt": "2017-08-07T12:08:36.151Z"
}
]
}
GET /sale/offer-additional-services/groups/{groupId}
Tym zasobem pobierzesz identyfikator danej grupy usług dodatkowych, którą możesz przypisać do ofert poprzez WebAPI. Aby to zrobić uzupełnij strukturę additionalServicesGroup, którą udostępniliśmy w parametrach wejściowych w metodach:
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/sale/offer-additional-services/groups/{groupId}' \
-H 'authorization: Bearer {token}' \
-H 'accept: application/vnd.allegro.public.v1+json’ \
Przykładowy response:
{
"id": "0a3e6ca4-b8fb-4cce-9d47-4ca47ef49903",
"name": "Pakiet prezent i wniesienie",
"seller": {
"id": "53703086"
},
"additionalServices": [
{
"definition": {
"id": "GIFT_WRAP"
},
"description": "Opis zapakuj na prezent",
"configurations": [
{
"price": {
"amount": "15",
"currency": "PLN"
},
"constraints": {
"type": "COUNTRY_SAME_QUANTITY",
"country": "PL"
}
}
]
},
{
"definition": {
"id": "CARRY_IN"
},
"description": "Opis wniesienia",
"configurations": [
{
"price": {
"amount": "16",
"currency": "PLN"
},
"constraintCriteria": {
"type": "COUNTRY_DELIVERY_SAME_QUANTITY",
"country": "PL",
"deliveryMethods": [
{"id": "7203cb90-864c-4cda-bf08-dc883f0c78ad"},
{"id": "45309171-0415-49cd-b2cf-89e9143d20f0"},
{"id": "2b6ca59d-1e4c-426c-82a9-efcbd730846b"},
{"id": "74bc07eb-552f-4581-b68c-da46716d4a9a"},
{"id": "ffb2643b-4b90-4925-9d29-0d93ad9488a6"}
]
}
}
]
}
],
"createdAt": "2017-08-04T12:46:36.996Z",
"updatedAt": "2017-08-04T12:46:36.996Z"
}
Identyfikatory i nazwy metod dostawy zwracane przez Allegro WebAPI metodą: doGetSellFormFieldsForCategory.
| Forma wysyłki | Numer fid |
Identyfikator metody dostawy |
| Przesyłka kurierska | 44 |
7203cb90-864c-4cda-bf08-dc883f0c78ad |
| Paczka pocztowa priorytetowa | 38 |
45309171-0415-49cd-b2cf-89e9143d20f0 |
| Paczka pocztowa ekonomiczna | 36 |
2b6ca59d-1e4c-426c-82a9-efcbd730846b |
| Paczka24 | 55 |
74bc07eb-552f-4581-b68c-da46716d4a9a |
| Paczka48 | 56 |
ffb2643b-4b90-4925-9d29-0d93ad9488a6 |
| Przesyłka kurierska pobraniowa | 45 |
845efe05-0c96-47c3-a8cb-aa4699c158ce |
| Przesyłka pobraniowa priorytetowa / Paczka24 pobranie | 42 |
b90c6295-b69a-4cb4-a308-7126a02aea47 |
| Przesyłka pobraniowa / Paczka48 pobranie | 40 |
97286096-eb28-40f9-9efc-95ecbb8624ea |
| Pocztex Kurier24 | 81 |
4dd9c904-e892-4649-bdec-5454d6b53d28 |
| Pocztex Kurier48 | 53 |
f7e952b5-9ae8-40a9-90dd-e71ab9da29dd |
| Pocztex Kurier24 pobraniowy | 82 |
b6bf5f9c-6cc8-4a0e-ab2f-bd49e76528f5 |
| Pocztex Kurier48 pobraniowy | 54 |
8cc6e982-0af4-4e12-be96-5387db79a166 |
| Odbiór osobisty | 35 |
a6e4845b-9ace-48ea-b232-918eaf11ba6c |
| Odbiór osobisty po przedpłacie | 35 |
57b987de-ce2d-4e73-9b9f-a7c9ebe9611d |
| Allegro MiniPaczka InPost | 50 |
9081532b-5ad3-467d-80bc-9252982e9dd8 |
| Allegro Kurier InPost | 61 |
5d9c7838-e05f-4dec-afdd-58e884170ba7 |
| Allegro Kurier InPost pobraniowy | 62 |
85c3ad2f-4ec1-446c-866e-63473ed10e26 |
| Kurier wieczór | 98 |
6a0f88ba-8f25-44fc-b1cf-25f45cbe8e72 |
| Kurier wieczór pobraniowy | 99 |
3ca09a1f-11f2-4763-974e-ae80404062c3 |
| Kurier UPS pobraniowy | 100 |
496c5d07-a095-4cf3-bc3a-2217e01172a3 |
| Kurier UPS | 101 |
b4525da7-fe10-4e89-af86-70479d3f251e |
| Kurier GLS pobraniowy | 102 |
1205bb4a-7d74-46a4-b7de-1cb66a3d0c03 |
| Kurier GLS | 103 |
059c0d58-6cdb-4955-ab79-9031518f80f3 |
| Kurier DHL pobraniowy | 104 |
8de8c002-9f06-4e91-b8bc-aebcae3b9fe7 |
| Kurier DHL | 105 |
c8be0338-63f9-42d8-bc78-ee2bd45980b6 |
| Kurier DPD pobraniowy | 106 |
259b5c7a-9056-4c74-80ec-8bdc50cb0413 |
| Kurier DPD | 107 |
c3066682-97a3-42fe-9eb5-3beeccab840c |
| Kurier FedEx pobraniowy | 108 |
ba32c220-71e1-4df6-ab2b-7d5ff19a952d |
| Kurier FedEx | 109 |
881504b1-13e5-4280-b453-f1211164778e |
| Kurier Raben pobraniowy | 110 |
25d687d5-5aab-41ef-afb6-c12ac1603c17 |
| Kurier Raben | 111 |
e4d44e17-d107-447b-bebf-d82c636fe739 |
| Kurier Rhenus pobraniowy | 112 |
ec6f7e1f-dda2-4ef3-bd34-deac136e0b4b |
| Kurier Rhenus | 113 |
ca225f8e-f5c5-42e9-a234-49fb629cd912 |
