Saltar al contenido

Crear pedidos

Solicitud

Crea un nuevo pedido en el sistema de ShipSaving. Se utiliza habitualmente para crear pedidos por adelantado antes de generar etiquetas de envío.
Límite de tasa: 300 solicitudes por minuto.

Seguridad
ApiTokenAuth
Cuerpoapplication/jsonrequerido
store_namestringrequerido

Apodo de la tienda registrado en tu cuenta de ShipSaving (Stores > Stores Nickname).

Ejemplo:"CS"
order_numberstring

Identificador único del pedido. Si se omite, se generará uno automáticamente.

Ejemplo:"202402071641"
warehouse_namestringrequerido

Nombre del almacén tal como aparece en tu cuenta de ShipSaving (Warehouses > Warehouses name).

Ejemplo:"WH"
verify_addressbooleanrequerido

Indica si la dirección del destinatario debe ser validada.

Ejemplo:true
client_namestringrequerido

Nombre completo del destinatario.

Ejemplo:"full name"
client_companystring

Nombre de la empresa del destinatario (si aplica).

Ejemplo:"company name"
client_emailstring

Dirección de correo electrónico del destinatario.

Ejemplo:""
client_phonestring

Número de teléfono del destinatario. Obligatorio para envíos internacionales.

Ejemplo:"1234567890"
client_streetstringrequerido

Dirección principal del destinatario.

Ejemplo:"123 street name"
client_street2string

Segunda línea de dirección, como número de apartamento o suite.

Ejemplo:"apt 123"
client_citystringrequerido

Ciudad de la dirección del destinatario.

Ejemplo:"city"
client_statestringrequerido

Estado o provincia de la dirección del destinatario.

Ejemplo:"state"
client_zipstringrequerido

Código ZIP o postal de la dirección del destinatario.

Ejemplo:"zipcode"
client_countrystring(country)requerido

Código de 2 letras del país de origen. El valor de este campo será un código ISO 3166-1 de dos dígitos.

Ejemplo:"US"
shipmentsArray of objectsrequerido

Lista de paquetes de envío incluidos en el pedido.

POST
/api/orders/create
curl -i -X POST \
  'https://api.shipsaving.com/api/orders/create?api_token=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "store_name": "CS",
    "order_number": "202402071641",
    "warehouse_name": "WH",
    "verify_address": true,
    "client_name": "full name",
    "client_company": "company name",
    "client_email": "",
    "client_phone": "1234567890",
    "client_street": "123 street name",
    "client_street2": "apt 123",
    "client_city": "city",
    "client_state": "state",
    "client_zip": "zipcode",
    "client_country": "US",
    "shipments": [
      {
        "length": 6,
        "width": 6,
        "height": 3,
        "weight": 0.4,
        "signature": "NO_SIGNATURE",
        "insurance_provider": "SHIPSURANCE",
        "insurance_amount": 200,
        "custom_print1": "this is a custom print 1 field",
        "custom_print2": "this is a custom print 2 field",
        "items": [
          {
            "sku": "2PCSFLCX-BLACK_PINK-S",
            "title": "2 t-shirts",
            "quantity": 1,
            "price": 20,
            "tax": 1.2,
            "shipping_cost": 10
          }
        ],
        "notes": [
          "note 1",
          "note 2"
        ]
      }
    ]
  }'

Respuestas

Pedido creado correctamente

Cuerpoapplication/json
order_numberstring

Número de pedido

Response
{ "order_number": "string" }