MIATECH REST API
API End Point: [Link]
Token End Point: [Link]
In Order to use the methods in the API, first need to generate an access token and use
that token to Authorize all the requests to call API methods.
Token Generation :
In Order to generate the token use Token End Point and Send the below parameters.
SNO Parameter Type Description
1 grant_type string The value is “password” for token generation
2 username string Unique Id given for the user to access API methods.
3 password string Password given to access the API methods.
4 client_id string Unique Id given to the user to validate the request
5 client_secret string Unique Id given to the user to validate the request.
You need to send the above parameters in KeyValue pairs as formUrlEncodedContent by
using the Token End Point to generate the token.
In Response to the above request, you will get below response in json format.
SNO Parameter Description
1 access_token Token to use in the request to call the API methods.
2 token_type Type of the Token, default it is bearer token.
3 expires_in Token Expiry time in seconds.
4 refresh_token Token that can be used to generate a new token after
expiration of access_token.
5 client_id Client Id you send in the Request.
6 userName Name of the client using the API.
7 refresh_token_exp_time Refresh Token Expiry time in minutes.
8 refresh_token_exp_date Expiry date of the Refresh Token (UCT date).
9 .issued Date of access token Issued (UCT date).
10 .expires Expiry date of access_token (UCT date).
Refresh Token:
Once the token is Expired, you can use the refresh token received while generating access
token, to generate the new token by sending below parameters in KeyValue pairs as
formUrlEncodedContent by using the Token End Point.
The response is same as the response while generating access token.
SNO Parameter Type Description
1 grant_type string The value is “refresh_token” to regenerate the access
token.
2 refresh_token string Refresh token received while generating access token.
SHIPPING API METHODS
1) POST api/ship/createshippingorder
This method is used to Create a Shipping. This method takes Shipping related information as parameters.
Parameters need to send in Json format.
SNO Parameter Type Required Description
1 Company String YES Internal Id need send 10
2 IdTrx String
3 contrato String
4 tipoServicio String
5 idPedido String
6 valorACobrar decimal
7 codigoVerificadorDeEntrega String
8 tipoProducto String
9 sucursalClienteID integer
10 productoAEntregar String
11 productoARetirar String
12 pagoDestino String
13 centroDeCostos string
14 categoriaFacturacion string
15 pagoEnMostrador_documentoNumero String
16 pagoEnMostrador_documentoTipo string
17 pagoEnMostrador_montoACobrar decimal
18 origen_postal_localidad string
19 origen_postal_region string
20 origen_postal_pais string Origin Country
21 origen_postal_codigoPostal string Origin Postal Code
22 origen_postal_calle string
23 origen_postal_numero string
24 origen_postal_componentesDeDireccion_meta string
25 origen_postal_componentesDeDireccion_contenido string
26 origen_sucursal_id string
27 origen_coordenadas_elevacion decimal
28 origen_coordenadas_latitud decimal Origin Latitude
29 origen_coordenadas_longitud decimal Origin Longitude
30 destino_postal_localidad string
31 destino_postal_region string
32 destino_postal_pais string Destination Country
33 destino_postal_codigoPostal string Destination Postal Code
34 destino_postal_calle string
35 destino_postal_numero string
36 destino_postal_componentesDeDireccion string
SNO Parameter Type Required Description
37 destino_sucursal_id string
38 destino_coordenadas_elevacion decimal
39 destino_coordenadas_latitud decimal Destination Latitude
40 destino_coordenadas_longitud decimal Destination Longitude
41 remitente_nombreCompleto string
42 remitente_eMail string
43 remitente_documentoTipo string
44 remitente_documentoNumero string
45 remitente_telefonos string
46 remitente_telefonos_tipo string
47 remitente_telefonos_numero string
48 destinatario_nombreCompleto string
49 destinatario_eMail string
50 destinatario_documentoTipo string
51 destinatario_documentoNumero string
52 destinatario_telefonos string
53 destinatario_telefonos_tipo integer
54 destinatario_telefonos_numero string
55 remito string
56 remito_numeroRemito string
57 remito_complementarios string
58 fechaDeEntrega string
59 fechaDeEntrega_fecha string
60 fechaDeEntrega_horaDesde string
61 fechaDeEntrega_horaHasta string
62 bultos_kilos decimal
63 bultos_largoCm decimal
64 bultos_altoCm decimal
65 bultos_anchoCm decimal
66 bultos_volumenCm decimal
67 bultos_valorDeclaradoSinImpuestos decimal
68 bultos_valorDeclaradoConImpuestos decimal
69 bultos_descripcion string
70 bultos_numeroDeEnvio string
71 bultos_referencias string
72 op_created string
RESPONSE
You will get below response in json format.
SNO Parameter Type Description
1 IsSuccess boolean Indicates whether the request is success or failure.
2 Id integer Unique Id of the Created Shipping Order.
3 Message string Contains message if the request failed.
2) POST api/ship/createshippingorderMega
This method is used to Create Multiple Shippings based on Bultos List. This method takes Shipping
related information as parameters.
Parameters need to send in Json format.
SNO Parameter Type Required Description
1 Company String YES Internal Id need send
10
2 IdTrx String
3 EnvioAbonado Boolean
4 numeroDeEnvio String
5 Contrato String
6 tipoServicio String
7 idPedido String
8 valorACobrar decimal
9 codigoVerificadorDeEntrega String
10 tipoProducto String
11 sucursalClienteID integer
12 productoAEntregar String
13 productoARetirar String
14 pagoDestino String
15 centroDeCostos string
16 categoriaFacturacion string
17 pagoEnMostrador_documentoNumero String
18 pagoEnMostrador_documentoTipo string
19 pagoEnMostrador_montoACobrar decimal
20 origen_postal_localidad string
21 origen_postal_region string
22 origen_postal_pais string Origin Country
23 origen_postal_codigoPostal string Origin Postal Code
24 origen_postal_calle string
25 origen_postal_numero string
26 origen_postal_componentesDeDireccion_meta string
27 origen_postal_componentesDeDireccion_contenido string
28 origen_sucursal_id string
29 origen_coordenadas_elevacion decimal
30 origen_coordenadas_latitud decimal Origin Latitude
31 origen_coordenadas_longitud decimal Origin Longitude
32 destino_postal_localidad string
33 destino_postal_region string
34 destino_postal_pais string Destination Country
35 destino_postal_codigoPostal string Destination Postal Code
36 destino_postal_calle string
37 destino_postal_numero string
38 destino_postal_componentesDeDireccion_meta string
39 destino_postal_componentesDeDireccion_contenido String
40 destino_sucursal_id string
41 destino_coordenadas_elevacion decimal
42 destino_coordenadas_latitud decimal Destination Latitude
43 destino_coordenadas_longitud decimal Destination Longitude
44 remitente_nombreCompleto string
45 remitente_eMail string
46 remitente_documentoTipo string
47 remitente_documentoNumero string
48 remitente_telefonos string
49 remitente_telefonos_tipo string
50 remitente_telefonos_numero string
51 destinatario_nombreCompleto string
52 destinatario_eMail string
53 destinatario_documentoTipo string
54 destinatario_documentoNumero string
55 destinatario_telefonos string
56 destinatario_telefonos_tipo integer
57 destinatario_telefonos_numero string
58 remito string
59 remito_numeroRemito string
60 remito_complementarios string
61 fechaDeEntrega string
62 fechaDeEntrega_fecha string
63 fechaDeEntrega_horaDesde string
64 fechaDeEntrega_horaHasta string
65 bultos List<Bulto> Bulto Class contains
properties mentioned
below.
66 observaciones string
67 sucursalDeDistribucion_nomenclatura string
68 sucursalDeDistribucion_descripcion string
69 sucursalDeDistribucion_id string
70 sucursalDeRendicion_nomenclatura string
71 sucursalDeRendicion_descripcion string
72 sucursalDeRendicion_id string
73 contrato_distribucion string
74 id_cliente string
75 numeroDePermisionaria string
76 descripcionServicio string
77 tipo_distribucion string
78 canal string
79 facturas_numeroBulto string
80 op_created string YES Name user creating the
Shipping.
BULTO Class
SNO Parameter Type Required Description
1 numeroBulto String Name of the Package
2 kilos Double Weight of the package
3 largoCm Integer Length of the package
4 altoCm Integer Width of the Package
5 anchoCm Integer Height of the Package.
6 volumenCm Double Volume of the Package.
7 valorDeclaradoSinImpuestos Double
8 valorDeclaradoConImpuestos Double
9 descripcion String Description of the
Package
10 numeroDeEnvio String
11 referencias String
12 QrEtiqueta Object of class QrEtiqueta Properties for QrEtiqueta
class are mentioned
below.
13 url string
QrEtiqueta Class
SNO Parameter Type Required Description
1 numeroDeEnvio String
2 numeroDeBulto String
3 cantidadDeBultos String
4 sucursalDeDistribucion Object of class Properties of
SucursalDeDistribucion SucursalDeDistribucion
class are mentioned below.
SucursalDeDistribucion Class
SNO Parameter Type Required Description
1 nomenclatura String
2 descripcion String
3 id String
RESPONSE
You will get below response in json format.
SNO Parameter Type Description
1 IsSuccess boolean Indicates whether the request is success or failure.
2 Id integer Unique Id of the Created Shipping Order.
3 Message string Contains message if the request failed.
