Documentación
superleads.mx
Documentación › Referencia de la API › Store

Store

Referencia de la API · ☕ 11 min de lectura
Actualizado el 19 Jun 2026

Store API

Documentación de la API de store

Servidor base: https://services.leadconnectorhq.com

Endpoints

POST /store/shipping-zone

Crear Shipping Zone The "Create Shipping Zone" API allows adding a new shipping zone.

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Name of the shipping zone - countries (requerido) — array — List of countries that are available - code (requerido) — number — Country code - states — array — List of states that are available. If states is empty, then all states are available - code (requerido) — string — State code

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-zone

Listar Shipping Zones The "List Shipping Zone" API allows to retrieve a list of shipping zone.

Parametros: - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - limit (query, number) — Cantidad máxima de resultados por página - offset (query, number) — Indice inicial de la página de resultados - withShippingRate (query, boolean) — Include shipping rates array

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-zone/{shippingZoneId}

Obtener Shipping Zone The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the item that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - withShippingRate (query, boolean) — Include shipping rates array

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /store/shipping-zone/{shippingZoneId}

Actualizar Shipping Zone The "update Shipping Zone" API allows update a shipping zone to the system.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the item that needs to be returned

Cuerpo de la peticion (application/json): - altId — string — Location Id or Agency Id - altType — string - name — string — Name of the shipping zone - countries — array — List of countries that are available - code (requerido) — number — Country code - states — array — List of states that are available. If states is empty, then all states are available - code (requerido) — string — State code

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /store/shipping-zone/{shippingZoneId}

Eliminar shipping zone Delete specific shipping zone with Id :shippingZoneId

Parametros: - shippingZoneId (path, string) (requerido) — Id of the item that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /store/shipping-zone/shipping-rates

Obtener available shipping rates This return available shipping rates for country based on order amount

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - country (requerido) — string — Country code of the customer - address — — Address of the customer - amountAvailable — string — it will not calculate the order amount form backend if it is true - totalOrderAmount (requerido) — number — The amount of the price. ( min: 0.01 ) - weightAvailable — boolean — Flag to pass when the weight is already calculated and should not calculate again - totalOrderWeight (requerido) — number — Estimated weight of the order calculated from the order creation side in kg(s) - source (requerido) — — Source of the order - products (requerido) — array — An array of price IDs and quantity - id (requerido) — string — id of product - qty (requerido) — number — No of quantities - couponCode — string — Coupon code

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /store/shipping-zone/{shippingZoneId}/shipping-rate

Crear Shipping Rate The "Create Shipping Rate" API allows adding a new shipping rate.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the item that needs to be returned

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Name of the shipping zone - description — string — Delivery description - currency (requerido) — string — The currency of the amount of the rate / handling fee - amount (requerido) — number — The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). - conditionType (requerido) — string — Type of condition to provide the conditional pricing - minCondition (requerido) — number — Minimum condition for applying this price. set 0 or null if there is no minimum - maxCondition (requerido) — number — Maximum condition for applying this price. set 0 or null if there is no maximum - isCarrierRate — boolean — is this a carrier rate - shippingCarrierId (requerido) — string — Shipping carrier id - percentageOfRateFee — number — Percentage of rate fee if it is a carrier rate. - shippingCarrierServices — array — An array of items - name (requerido) — string — Name of the shipping carrier service - value (requerido) — string — Value of the shipping carrier service

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-zone/{shippingZoneId}/shipping-rate

Listar Shipping Rates The "List Shipping Rate" API allows to retrieve a list of shipping rate.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the item that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - limit (query, number) — Cantidad máxima de resultados por página - offset (query, number) — Indice inicial de la página de resultados

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}

Obtener Shipping Rate The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the shipping zone - shippingRateId (path, string) (requerido) — Id of the shipping rate that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}

Actualizar Shipping Rate The "update Shipping Rate" API allows update a shipping rate to the system.

Parametros: - shippingZoneId (path, string) (requerido) — Id of the shipping zone - shippingRateId (path, string) (requerido) — Id of the shipping rate that needs to be returned

Cuerpo de la peticion (application/json): - altId — string — Location Id or Agency Id - altType — string - name — string — Name of the shipping zone - description — string — Delivery description - currency — string — The currency of the amount of the rate / handling fee - amount — number — The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate). - conditionType — string — Type of condition to provide the conditional pricing - minCondition — number — Minimum condition for applying this price. set 0 or null if there is no minimum - maxCondition — number — Maximum condition for applying this price. set 0 or null if there is no maximum - isCarrierRate — boolean — is this a carrier rate - shippingCarrierId — string — Shipping carrier id - percentageOfRateFee — number — Percentage of rate fee if it is a carrier rate. - shippingCarrierServices — array — An array of items - name (requerido) — string — Name of the shipping carrier service - value (requerido) — string — Value of the shipping carrier service

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}

Eliminar shipping rate Delete specific shipping rate with Id :shippingRateId

Parametros: - shippingZoneId (path, string) (requerido) — Id of the shipping zone - shippingRateId (path, string) (requerido) — Id of the shipping rate that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /store/shipping-carrier

Crear Shipping Carrier The "Create Shipping Carrier" API allows adding a new shipping carrier.

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Name of the shipping carrier - callbackUrl (requerido) — string — The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL. - services — array — An array of available shipping carrier services - name (requerido) — string — Name of the shipping carrier service - value (requerido) — string — Value of the shipping carrier service - allowsMultipleServiceSelection — boolean — The seller can choose multiple services while creating shipping rates if this is true.

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-carrier

Listar Shipping Carriers The "List Shipping Carrier" API allows to retrieve a list of shipping carrier.

Parametros: - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/shipping-carrier/{shippingCarrierId}

Obtener Shipping Carrier The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier.

Parametros: - shippingCarrierId (path, string) (requerido) — Id of the shipping carrier that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /store/shipping-carrier/{shippingCarrierId}

Actualizar Shipping Carrier The "update Shipping Carrier" API allows update a shipping carrier to the system.

Parametros: - shippingCarrierId (path, string) (requerido) — Id of the shipping carrier that needs to be returned

Cuerpo de la peticion (application/json): - altId — string — Location Id or Agency Id - altType — string - name — string — Name of the shipping carrier - callbackUrl — string — The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL. - services — array — An array of available shipping carrier services - name (requerido) — string — Name of the shipping carrier service - value (requerido) — string — Value of the shipping carrier service - allowsMultipleServiceSelection — boolean — The seller can choose multiple services while creating shipping rates if this is true.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /store/shipping-carrier/{shippingCarrierId}

Eliminar shipping carrier Delete specific shipping carrier with Id :shippingCarrierId

Parametros: - shippingCarrierId (path, string) (requerido) — Id of the shipping carrier that needs to be returned - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /store/store-setting

Create/Update Store Settings Create or update store settings by altId and altType.

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - shippingOrigin (requerido) — — Shipping origin address - storeOrderNotification — — Store order notification email - storeOrderFulfillmentNotification — — Store order fulfillment notification email

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /store/store-setting

Obtener Store Settings Get store settings by altId and altType.

Parametros: - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar