Direcciones

Es la entidad que almacena la información específica de las direcciones que un usuario tiene en su cuenta. Ya que un usuario puede tener múltiples direcciones tanto de facturación, como de entrega.

Listado de direcciones pertenecientes a un usuario.

GET https://tiendagoshop.com/api/v1/users/:user_id/user_address_templates

Path Parameters

Name
Type
Description

user_id

string

ID del usuario

Query Parameters

Name
Type
Description

q[external_id_eq]

String

Id externo

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

{
    "user_address_templates": [
        {
            "id": 1,
            "firstname": "Pedro",
            "lastname": "Guzman",
            "full_name": "Pedro Guzman",
            "address1": "Ave. 27 de Febrero 283",
            "address2": null,
            "city": "Santo Domingo",
            "zipcode": "",
            "phone": "8091112222",
            "company": null,
            "alternative_phone": null,
            "country_id": 1,
            "state_id": 1,
            "state_name": null,
            "state_text": "01",
            "address_type": "billing",
            "rnc": "",
            "fiscal_type": "consumidor",
            "last_used": "2020-09-30T15:44:30.310Z",
            "geo_address": null,
            "geo_lat": null,
            "geo_lng": null,
            "user_id": 1,
            "country": {
                "id": 1,
                "iso_name": "DOMINICAN REPUBLIC",
                "iso": "DO",
                "iso3": "DOM",
                "name": "Dominican Republic",
                "numcode": 214
            },
            "state": {
                "id": 1,
                "name": "Distrito Nacional (Santo Domingo)",
                "abbr": "01",
                "country_id": 1
            }
        },
        {
            "id": 2,
            "firstname": "Pedro",
            "lastname": "Guzman",
            "full_name": "Pedro Guzman",
            "address1": "Ave. 27 de Febrero 283",
            "address2": null,
            "city": "Santo Domingo",
            "zipcode": "",
            "phone": "8091112222",
            "company": null,
            "alternative_phone": null,
            "country_id": 1,
            "state_id": 1,
            "state_name": null,
            "state_text": "01",
            "address_type": "shipping",
            "rnc": null,
            "fiscal_type": null,
            "last_used": "2020-09-30T15:44:30.312Z",
            "geo_address": null,
            "geo_lat": null,
            "geo_lng": null,
            "user_id": 1,
            "country": {
                "id": 1,
                "iso_name": "DOMINICAN REPUBLIC",
                "iso": "DO",
                "iso3": "DOM",
                "name": "Dominican Republic",
                "numcode": 214
            },
            "state": {
                "id": 1,
                "name": "Distrito Nacional (Santo Domingo)",
                "abbr": "01",
                "country_id": 1
            }
        },
    ],
    "count": 2,
    "current_page": 1,
    "pages": 1
}

Crear una nueva dirección a un usuario

POST https://tiendagoshop.com/api/v1/users/:user_id/user_address_templates

Path Parameters

Name
Type
Description

user_id

string

ID del usuario

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

Request Body

Name
Type
Description

firstname

string

Nombres.

lastname

string

Apellidos

address1

string

Dirección

city

string

Ciudad

phone

integer

Telefono

state_id

integer

ID de ciudad.

address_type

string

Tipo de facturación.

fiscal_type

string

Tipo de ente fiscal.

external_id

string

Id externo

{
  "id": 13,
  "firstname": "Pepe",
  "lastname": "Muñoz",
  "full_name": "Pepe Muñoz",
  "address1": "Ave. 27 de Febrero 948",
  "address2": null,
  "city": "Santo Domingo",
  "zipcode": null,
  "phone": "8091112222",
  "company": null,
  "alternative_phone": null,
  "country_id": 1,
  "state_id": 1,
  "state_name": null,
  "state_text": "01",
  "address_type": "billing",
  "rnc": null,
  "fiscal_type": "consumidor",
  "last_used": null,
  "geo_address": null,
  "geo_lat": null,
  "geo_lng": null,
  "user_id": 1,
  "country": {
    "id": 1,
    "iso_name": "DOMINICAN REPUBLIC",
    "iso": "DO",
    "iso3": "DOM",
    "name": "Dominican Republic",
    "numcode": 214
  },
  "state": {
    "id": 1,
    "name": "Distrito Nacional (Santo Domingo)",
    "abbr": "01",
    "country_id": 1
  }
}

Modificar una dirección perteneciente a un usuario.

PUT https://tiendagoshop.com/api/v1/users/:user_id/user_address_templates/:id

Path Parameters

Name
Type
Description

id

string

ID de la dirección del usuario

user_id

string

ID del usuario

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

Request Body

Name
Type
Description

firstname

string

Nombres

lastname

string

Apellidos

address1

string

Dirección del usuario.

city

string

Cidudad

phone

integer

Telefóno.

state_id

integer

ID de la ciudad.

address_type

string

Tipo de facturación.

fiscal_type

string

Tipo de ente fiscal.

external_id

string

Id externo

{
  "id": 13,
  "firstname": "Pepe",
  "lastname": "Muñoz",
  "full_name": "Pepe Muñoz",
  "address1": "Ave. 27 de Febrero 948",
  "address2": null,
  "city": "Santo Domingo",
  "zipcode": null,
  "phone": "8091112222",
  "company": null,
  "alternative_phone": null,
  "country_id": 1,
  "state_id": 1,
  "state_name": null,
  "state_text": "01",
  "address_type": "billing",
  "rnc": null,
  "fiscal_type": "consumidor",
  "last_used": null,
  "geo_address": null,
  "geo_lat": null,
  "geo_lng": null,
  "user_id": 1,
  "country": {
    "id": 1,
    "iso_name": "DOMINICAN REPUBLIC",
    "iso": "DO",
    "iso3": "DOM",
    "name": "Dominican Republic",
    "numcode": 214
  },
  "state": {
    "id": 1,
    "name": "Distrito Nacional (Santo Domingo)",
    "abbr": "01",
    "country_id": 1
  }
}

Eliminar una dirección perteneciente a un usuario.

DELETE https://tiendagoshop.com/api/v1/users/:user_id/user_address_templates/:id

Path Parameters

Name
Type
Description

id

integer

ID de la dirección de usuario.

user_id

integer

ID del usuario.

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

Listado provincias.

GET https://tiendagoshop.com/api/v1/states

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

{
    "states": [
        {
            "id": 2,
            "name": "Azua",
            "abbr": "02",
            "country_id": 1
        },
        {
            "id": 3,
            "name": "Bahoruco",
            "abbr": "03",
            "country_id": 1
        },
        {
            "id": 4,
            "name": "Barahona",
            "abbr": "04",
            "country_id": 1
        },
        {
            "id": 5,
            "name": "Dajabón",
            "abbr": "05",
            "country_id": 1
        },
        {
            "id": 1,
            "name": "Distrito Nacional (Santo Domingo)",
            "abbr": "01",
            "country_id": 1
        },
        {
            "id": 6,
            "name": "Duarte",
            "abbr": "06",
            "country_id": 1
        },
        {
            "id": 8,
            "name": "El Seybo [El Seibo]",
            "abbr": "08",
            "country_id": 1
        },
        {
            "id": 9,
            "name": "Espaillat",
            "abbr": "09",
            "country_id": 1
        },
        {
            "id": 30,
            "name": "Hato Mayor",
            "abbr": "30",
            "country_id": 1
        },
        {
            "id": 10,
            "name": "Independencia",
            "abbr": "10",
            "country_id": 1
        },
        {
            "id": 11,
            "name": "La Altagracia",
            "abbr": "11",
            "country_id": 1
        },
        {
            "id": 7,
            "name": "La Estrelleta [Elías Piña]",
            "abbr": "07",
            "country_id": 1
        },
        {
            "id": 12,
            "name": "La Romana",
            "abbr": "12",
            "country_id": 1
        },
        {
            "id": 13,
            "name": "La Vega",
            "abbr": "13",
            "country_id": 1
        },
        {
            "id": 14,
            "name": "María Trinidad Sánchez",
            "abbr": "14",
            "country_id": 1
        },
        {
            "id": 28,
            "name": "Monseñor Nouel",
            "abbr": "28",
            "country_id": 1
        },
        {
            "id": 15,
            "name": "Monte Cristi",
            "abbr": "15",
            "country_id": 1
        },
        {
            "id": 29,
            "name": "Monte Plata",
            "abbr": "29",
            "country_id": 1
        },
        {
            "id": 16,
            "name": "Pedernales",
            "abbr": "16",
            "country_id": 1
        },
        {
            "id": 17,
            "name": "Peravia",
            "abbr": "17",
            "country_id": 1
        },
        {
            "id": 18,
            "name": "Puerto Plata",
            "abbr": "18",
            "country_id": 1
        },
        {
            "id": 19,
            "name": "Salcedo",
            "abbr": "19",
            "country_id": 1
        },
        {
            "id": 20,
            "name": "Samaná",
            "abbr": "20",
            "country_id": 1
        },
        {
            "id": 21,
            "name": "San Cristóbal",
            "abbr": "21",
            "country_id": 1
        },
        {
            "id": 22,
            "name": "San Juan",
            "abbr": "22",
            "country_id": 1
        },
        {
            "id": 23,
            "name": "San Pedro de Macorís",
            "abbr": "23",
            "country_id": 1
        },
        {
            "id": 24,
            "name": "Sánchez Ramírez",
            "abbr": "24",
            "country_id": 1
        },
        {
            "id": 25,
            "name": "Santiago",
            "abbr": "25",
            "country_id": 1
        },
        {
            "id": 26,
            "name": "Santiago Rodríguez",
            "abbr": "26",
            "country_id": 1
        },
        {
            "id": 27,
            "name": "Valverde",
            "abbr": "27",
            "country_id": 1
        }
    ]
}

Listado de tipos de comprobante fiscal.

GET https://tiendagoshop.com/api/v1/address_fiscal_types

Headers

Name
Type
Description

X-Spree-Token

string

Token generado desde el CMS de GS

[
    "credito_fiscal",
    "consumidor",
    "gubernamental",
    "especiales"
]
AnteriorSegmento de usuariosSiguienteRoles

Última actualización