{"info":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","description":"

The APLIN REST API allows you to connect your inbounds, outbounds and inventory with your own system.

Authentication

Generate a JWT using your client secret.

Rate limit

No.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"19365662","collectionId":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","publishedId":"UVeMGhwe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"ff8d73"},"publishDate":"2022-02-10T17:52:03.000Z"},"item":[{"name":"Authentication","item":[{"name":"Generate token","id":"6798f885-0835-4921-a086-bbcf3b2238eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientSecret\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.aplin.mx/auth/token","description":"

Generate JWT bearer token.

\n","urlObject":{"path":["auth","token"],"host":["https://api.aplin.mx"],"query":[],"variable":[]}},"response":[],"_postman_id":"6798f885-0835-4921-a086-bbcf3b2238eb"}],"id":"cfcc32fd-afb5-4edf-b54a-bf036d0d6f21","_postman_id":"cfcc32fd-afb5-4edf-b54a-bf036d0d6f21","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","type":"collection"}}},{"name":"Orders","item":[{"name":"Get all orders","id":"d4a175c0-32f4-45da-ac08-53f2c230dbb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aplin.mx/orders","description":"

Get n orders by creation time, in a descending order. You may provide a time and get orders after and before that time, or provide no time at all and get the first orders.

startAfter and finishBefore is valid in any format accepted to create a date.

The endpoint returns orders in descending manner:

12 Feb
11 Feb
10 Feb

If we send a startAfter of 13 Feb and a finishBefore 12 Feb it will only return orders for Feb 12.

Get an outbound order by id.

Create an outbound order. All fields are suggested since they help us give a better delivery experience. Non mandatory fields are street2, lastName, and shipping.

Order Type

Type indicated the order type. This allows us to give special treatment to different order types.

Available order types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Description	Type code
Amazon FBA	amazon_cedis
Att Cedis	att_cedis
Coppel Cedis	coppel_cedis
Insured D2C	dropship_asegurado
D2C	dropship
Elektra Cedis	elektra_cedis
Export	export
Innova Sport	innova_sport
Liverpool Cedis	liverpool_cedis
Mercado Libre FULL	mercadolibre_cedis
Movistar Cedis	movistar_cedis
Radioshack Cedis	radioshack_cedis
Retail	retail
Sanborns CEDIS	sanborns_cedis
Sears CEDIS	sears_cedis
Uppin Cedis	uppin_cedis

Shipping

The shipping field is a free text. It must be configured to select the right courier. Please contact us.

Update an order.

WARNING: This method is not developed, Do not implement it yet.

Add a label to an order. Its really important that you send a correct file name and mime type such as label.pdf and application/pdf.

The fileBase64 is the label in base64 encoding, such as the string \"SW0gYSBsYWJlbA==\" which decodes \"Im a label\"

Delete an order.

WARNING: This method is not developed, Do not implement it yet.

Get all the inventory items for a client. It will return the following info:

{\n \"name\": Product's name,\n \"price\": Product's price,\n \"quantity\": Total quantity,\n \"booked\": Booked inventory,\n \"quarantine\": Quarantined inventory,\n \"sellable\": Total available for sale,\n \"quantityPerPackage\": Quantity per package (box),\n \"quantityPerPallet\": Quantity per pallet\n }

Get n inbounds by creation time, in a descending order. You may provide a time and get inbounds after that time, or provide no time at all and get the first orders.

startAfter is valid in any format accepted to create a date.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","type":"collection"}},"urlObject":{"path":["inbounds"],"host":["https://api.aplin.mx"],"query":[{"key":"limit","value":"pageLimit"},{"key":"startAfter","value":"startAfter"}],"variable":[]}},"response":[],"_postman_id":"afedc4f4-6c81-49f6-a3bb-f626871c423d"},{"name":"Get inbound by Id","id":"f82f9d1c-6ea5-4286-bc2a-52ba1d95e937","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.aplin.mx/inbounds/:inboundId","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","type":"collection"}},"urlObject":{"path":["inbounds",":inboundId"],"host":["https://api.aplin.mx"],"query":[],"variable":[]}},"response":[],"_postman_id":"f82f9d1c-6ea5-4286-bc2a-52ba1d95e937"},{"name":"Create inbound","id":"656e2e20-64a9-455b-82e6-0594c216c723","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \":inboundId\",\n \"comments\": \"Please check all boxes\",\n \"inboundDate\": \"10/03/2022\",\n \"inboundItems\": [{\n \"price\": 200,\n \"quantity\": 20,\n \"sku\": \"A01\",\n \"tax\": null\n }],\n \"reference\": \"Pedimento UKD02020\",\n \"supplier\": {\n \"id\": \"100\",\n \"name\": \"Promocionales Gomez\",\n \"reference\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.aplin.mx/inbounds/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","type":"collection"}},"urlObject":{"path":["inbounds",""],"host":["https://api.aplin.mx"],"query":[],"variable":[]}},"response":[],"_postman_id":"656e2e20-64a9-455b-82e6-0594c216c723"},{"name":"Edit inbound by Id","id":"4bd04145-a031-48b1-a038-ba9c02c57906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.aplin.mx/inbounds/:inboundId","description":"

Edit an inbound.

WARNING: This method is not developed, Do not implement it yet.

Delete an inbound.

WARNING: This method is not developed, Do not implement it yet.

Introduction

Webhooks are triggered following a change in certain scopes. Scopes are the information that changed in the resource. Not all changes to the resource trigger a webhook. Current scopes are:

fulfillmentStatus: The status related to the logistic operation of the resource (ex, the order has been packed).
delivered: Boolean field indicating of all the labels of the order are delivered.
labels: The labels of the order.
status: Data related status.

Retries

In case of failure, they are retried 5 times with increasing time intervals between each attempt: 2s, 4s, 8s, 16s, 32s, 64s.

Payload

The webhook payload has the following format:

{\n  \"clientId\": \"The client's id\",\n  \"resource\": \"The resource that changed: orders or inbounds\",\n  \"source\": \"In case it was an order, the sales channel that created the order\",\n  \"orderId\": \"The id of the order (if it's not an order this field wont exist)\",\n  \"inboundId\": \"The id of the inbound (if it's not an inbound this field wont exist)\",\n  \"scope\": \"The field that changed\",\n  \"message\": \"The new value of the field\",\n  \"timestamp\": \"The date and time of the webhook\"\n}\n

Example

{\n  \"clientId\": \"superstore\",\n  \"resource\": \"orders\",\n  \"source\": \"api\",\n  \"orderId\": \"ORDER001\",\n  \"scope\": \"fulfillmentStatus\",\n  \"message\": 450,\n  \"timestamp\": \"2023-06-29T15:40:47.783Z\"\n}\n\n

Authentication

The authentication of the webhook requests is done through a hash. The hash is created with the sha256 algorithm and the hash key is the API key of the store, each request of our webhook contains a header called X-Hmac-256 where the authentication hash is sent, to perform the security validation you can generate a hash with the same algorithm, the API key as a key, and the body of the webhook and compare this hash with the one received from the webhook.

Setup

To configure it, it is only necessary to include the URL of the endpoint in the connections section of your Dasbhoard.

List of possible messages

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scope	Message	Description	Notes	Resource
fulfillmentStatus	200	Open	Order created, it will not be processed until its release.	orders
fulfillmentStatus	300	Released	The fulfillment is approved and will start soon.	orders
fulfillmentStatus	320	Assigned	Picking initiated.	orders
fulfillmentStatus	370	Paused	Fulfillment stopped.	orders
fulfillmentStatus	399	Fulfillment cancelled	Fulfillment cancelled before its shipment, a return will be made.	orders
fulfillmentStatus	400	Picked	The items of the order were picked.	orders
fulfillmentStatus	450	Packed	The order is packed.	orders
fulfillmentStatus	500	Shipped	The order has left the warehouse towards its destination.	orders
fulfillmentStatus	510	Returned	The order was returned after being assorted.	orders
fulfillmentStatus	1000	Cancelled	The order was cancelled before its assortment.	orders
fulfillmentStatus	100	Notified	The inbound was created and successfully notified to the warehouse.	inbounds
fulfillmentStatus	200	Arrived	The inbound arrived at the warehouse.	inbounds
fulfillmentStatus	300	In process	We have started unloading and counting the inbound.	inbounds
fulfillmentStatus	400	Difference	(Only if) Differences were found between the pre-notified quantity and the counted one at the end of counting. Inbounding process is stopped until difference is approved.	inbounds
fulfillmentStatus	450	Difference approved	(Only if) The difference was approved.	inbounds
fulfillmentStatus	475	Received	The inbound was received and will be allocated in the warehouse.	inbounds
fulfillmentStatus	500	Inbounded	All products have been allocated in the warehouse.	inbounds
fulfillmentStatus	900	Cancelled		inbounds
delivered	false	One or more guides of the order have not been delivered		orders
delivered	true	All guides of the order were delivered		orders
labels	<labels[] array>	Some of the order's labels were modified.		orders

","_postman_id":"84006474-8d4c-4c31-920c-3b3ed58207cb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","id":"0e9a678b-808b-4e7c-b0aa-21a4a6fc98d4","name":"Aplin API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"7c49ed48-d224-4edb-8e14-a76270fb6acc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"33233118-4afc-457a-b7bb-56b8d7394872","type":"text/javascript","exec":[""]}}],"variable":[{"key":"orderId","value":":orderId"},{"key":"pageLimit","value":"pageLimit"},{"key":"itemId","value":":itemId"},{"key":"url","value":"https://api.aplin.mx"},{"key":"inboundId","value":":inboundId"},{"key":"startAfter","value":"startAfter"},{"key":"finishBefore","value":":finishBefore"},{"key":"clientSecret","value":""},{"key":"token","value":""}]}