eBay
eBay business policies, inventory locations, marketplaces, item conditions and shipping services.
/ebay/marketplacesEvery marketplace DoctorX recognises, with its default currency and locale. supported: false means recognised but not selectable yet. Read this before setting a shop marketplace rather than hard-coding ids.
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/marketplaces' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/conditionsThe item conditions an eBay listing can carry. Pass shopId and categoryId to get the set eBay actually allows in that category: measured across 2,773 categories, eBay offers between 0 and 8 and requires one on 96% of them, and NO category accepts the full marketplace-wide list. Without both parameters this returns that marketplace-wide list unchanged, which is a superset and may include conditions the category will refuse.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shopIdrequired | query | string | |
categoryIdrequired | query | string |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/conditions?shopId=string&categoryId=string' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/shipping-servicesCodes valid for shippingServiceCode on a fulfillment policy, each with its carrier. Pass shopId to read the list eBay publishes for THAT shop and marketplace, which is the only list that is right for a non-US marketplace (an AU shop ships AU_Regular, not USPSPriority) and the only one that reflects what eBay will actually accept - a code with ValidForSellingFlow: false is refused at policy creation with 20403 LSAS validation failed. With no shopId the response is the static US catalogue, unchanged.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shopId | query | string | Read the list from eBay for this shop. Omit for the static US catalogue. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
marketplaceId | query | string | Defaults to the shop's own default marketplace. One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/shipping-services' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/configPolicies grouped by type, inventory locations, and whether the seller is opted in to eBay Business Policies. One call to check publish readiness. businessPoliciesOptedIn: false means policy creation will fail until the seller opts in on eBay.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shopIdrequired | query | string | The eBay shop to read configuration for. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
marketplaceId | query | string | Defaults to the shop's own default marketplace. One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/config?shopId=string' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/syncMirrors what the seller has in eBay Seller Hub into DoctorX. Idempotent by eBay policy id, so it is safe to repeat. Each source is best-effort: a partial failure still returns the rest and names what failed in syncSummary.failed.
Request body
shopIdstringrequiredThe eBay shop to read configuration for.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringDefaults to the shop's own default marketplace.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X POST 'https://api.doctorx.vn/api/public/v1/ebay/sync' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string"
}'/ebay/shop-marketplaceThe marketplace every shop-scoped eBay call resolves against when nothing overrides it. EU and UK marketplaces additionally require the app-level eBay signing key to be configured.
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringrequiredeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PUT 'https://api.doctorx.vn/api/public/v1/ebay/shop-marketplace' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"marketplaceId": "EBAY_US"
}'/ebay/policiesFlat list across all three types for one shop and marketplace. data carries eBay's verbatim policy payload. Filter with ?type=fulfillment|payment|return.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shopIdrequired | query | string | The eBay shop to read configuration for. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
marketplaceId | query | string | Defaults to the shop's own default marketplace. One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/policies?shopId=string' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/policies/fulfillmentCreated on eBay and mirrored locally. shippingCost is required when shippingCostType is FLAT_RATE, and the international fields are required together; both are checked here rather than left to eBay, whose error does not name the missing field.
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
handlingTimeDaysintegerrequiredBusiness days before dispatch (eBay handlingTime).
min 0 · max 30
shippingServiceCodestringrequiredeBay shipping service code, e.g. USPSGround. See GET /ebay/shipping-services.
min length 1 · max length 60
shippingCostTypestringrequiredOne of: "FLAT_RATE", "CALCULATED", "FREE"
shippingCoststringRequired when shippingCostType is FLAT_RATE, ignored otherwise.
pattern ^\d+(\.\d{1,2})?$
shipToInternationalbooleaninternationalShippingServiceCodestringRequired when shipToInternational is true.
max length 60
internationalShippingCoststringRequired when shipToInternational is true and shippingCostType is FLAT_RATE.
pattern ^\d+(\.\d{1,2})?$
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X POST 'https://api.doctorx.vn/api/public/v1/ebay/policies/fulfillment' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"handlingTimeDays": 0,
"shippingServiceCode": "string",
"shippingCostType": "FLAT_RATE"
}'/ebay/policies/paymentRequest body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
immediatePaybooleanRequire payment before the order is created.
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X POST 'https://api.doctorx.vn/api/public/v1/ebay/policies/payment' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string"
}'/ebay/policies/returneBay accepts a return window of 14, 30 or 60 days ONLY. A 10 or 15 day window is rejected by eBay with an error that does not explain why, so it is refused here.
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
returnsAcceptedbooleanrequiredreturnDays14 | 30 | 60Return window. eBay accepts 14, 30 or 60 ONLY: a 10 or 15 day window is rejected by eBay with an error that does not say why, so it is refused here. Ignored when returnsAccepted is false.
returnShippingPayerstringOne of: "BUYER", "SELLER"
refundMethodstringOne of: "MONEY_BACK", "MERCHANDISE_CREDIT"
restockingFeePercentintegermin 0 · max 20
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X POST 'https://api.doctorx.vn/api/public/v1/ebay/policies/return' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"returnsAccepted": false
}'/ebay/policies/fulfillment/{id}Updated IN PLACE on eBay, so every offer already using it picks up the change. The eBay policy id does not change.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
handlingTimeDaysintegerrequiredBusiness days before dispatch (eBay handlingTime).
min 0 · max 30
shippingServiceCodestringrequiredeBay shipping service code, e.g. USPSGround. See GET /ebay/shipping-services.
min length 1 · max length 60
shippingCostTypestringrequiredOne of: "FLAT_RATE", "CALCULATED", "FREE"
shippingCoststringRequired when shippingCostType is FLAT_RATE, ignored otherwise.
pattern ^\d+(\.\d{1,2})?$
shipToInternationalbooleaninternationalShippingServiceCodestringRequired when shipToInternational is true.
max length 60
internationalShippingCoststringRequired when shipToInternational is true and shippingCostType is FLAT_RATE.
pattern ^\d+(\.\d{1,2})?$
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PUT 'https://api.doctorx.vn/api/public/v1/ebay/policies/fulfillment/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"handlingTimeDays": 0,
"shippingServiceCode": "string",
"shippingCostType": "FLAT_RATE"
}'/ebay/policies/payment/{id}Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
immediatePaybooleanRequire payment before the order is created.
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PUT 'https://api.doctorx.vn/api/public/v1/ebay/policies/payment/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string"
}'/ebay/policies/return/{id}Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
marketplaceIdstringeBay marketplace, e.g. EBAY_US. Policies are per-marketplace and cannot be used across marketplaces.
One of: "EBAY_US", "EBAY_GB", "EBAY_DE", "EBAY_AU", "EBAY_CA", "EBAY_FR", "EBAY_IT", "EBAY_ES", "EBAY_IE", "EBAY_AT", "EBAY_CH", "EBAY_NL", "EBAY_BE", "EBAY_PL", "EBAY_CA_FR"
namestringrequiredeBay caps policy names at 64 characters.
min length 1 · max length 64
returnsAcceptedbooleanrequiredreturnDays14 | 30 | 60Return window. eBay accepts 14, 30 or 60 ONLY: a 10 or 15 day window is rejected by eBay with an error that does not say why, so it is refused here. Ignored when returnsAccepted is false.
returnShippingPayerstringOne of: "BUYER", "SELLER"
refundMethodstringOne of: "MONEY_BACK", "MERCHANDISE_CREDIT"
restockingFeePercentintegermin 0 · max 20
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PUT 'https://api.doctorx.vn/api/public/v1/ebay/policies/return/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"returnsAccepted": false
}'/ebay/policies/{id}/defaultPublish uses the default when a template names no policy. At most one default per shop, marketplace and type, so this clears the previous one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PATCH 'https://api.doctorx.vn/api/public/v1/ebay/policies/string/default' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"/ebay/policies/{id}Deleted on eBay as well. eBay refuses to delete a policy an active listing still uses, and that refusal is surfaced as channel_error with eBay's own reason.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X DELETE 'https://api.doctorx.vn/api/public/v1/ebay/policies/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"/ebay/locationsLocations are shop-scoped, not marketplace-scoped. An offer references one by merchantLocationKey, and publish refuses without one.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shopIdrequired | query | string | DoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/ebay/locations?shopId=string' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/ebay/locationsCreated on eBay and mirrored locally. merchantLocationKey is generated from the name when omitted and is immutable afterwards, because live offers reference it.
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
namestringrequiredmin length 1 · max length 200
merchantLocationKeystringGenerated from the name when omitted. Immutable once created.
max length 36
addressLine1stringrequiredmin length 1 · max length 300
addressLine2stringmax length 300
citystringrequiredmin length 1 · max length 150
stateOrProvincestringrequiredmin length 1 · max length 150
postalCodestringrequiredmin length 1 · max length 50
countrystringrequiredISO 3166-1 alpha-2, e.g. US.
min length 2 · max length 10
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X POST 'https://api.doctorx.vn/api/public/v1/ebay/locations' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}'/ebay/locations/{id}The address and name change; merchantLocationKey does not.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Request body
shopIdstringrequiredDoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained.
pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
namestringrequiredmin length 1 · max length 200
merchantLocationKeystringGenerated from the name when omitted. Immutable once created.
max length 36
addressLine1stringrequiredmin length 1 · max length 300
addressLine2stringmax length 300
citystringrequiredmin length 1 · max length 150
stateOrProvincestringrequiredmin length 1 · max length 150
postalCodestringrequiredmin length 1 · max length 50
countrystringrequiredISO 3166-1 alpha-2, e.g. US.
min length 2 · max length 10
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PUT 'https://api.doctorx.vn/api/public/v1/ebay/locations/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"shopId": "string",
"name": "string",
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}'/ebay/locations/{id}Deleted on eBay as well. Deleting the location a live offer references breaks that offer, so eBay may refuse.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X DELETE 'https://api.doctorx.vn/api/public/v1/ebay/locations/string' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"/ebay/locations/{id}/defaultPublish uses the default when a template names no location.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X PATCH 'https://api.doctorx.vn/api/public/v1/ebay/locations/string/default' \
-H "Authorization: Bearer $DOCTORX_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"