{"info": {"name": "Yaqin Carrier API v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Shipping companies on Yaqin ERP (VLUMU Digital). Choose the environment \"Yaqin Carrier API — Sandbox\", fill client_id and client_secret, then run the requests in order. Full reference: https://app.yaqinerp.com/api/shipping/v1/  ·  OpenAPI: https://app.yaqinerp.com/api/shipping/v1/openapi.json"}, "auth": {"type": "bearer", "bearer": [{"key": "token", "value": "{{access_token}}", "type": "string"}]}, "event": [{"listen": "prerequest", "script": {"type": "text/javascript", "exec": ["// Signs in once and keeps the access token in the environment until it is close to expiring.", "const exp = Number(pm.environment.get('token_expires') || 0);", "if (pm.environment.get('access_token') && Date.now() < exp - 60000) { return; }", "if (!pm.environment.get('client_id') || !pm.environment.get('client_secret')) { console.warn('Set client_id and client_secret in the environment'); return; }", "pm.sendRequest({", "  url: pm.environment.get('base_url') + '/oauth/token', method: 'POST',", "  header: { 'Content-Type': 'application/json' },", "  body: { mode: 'raw', raw: JSON.stringify({ grant_type: 'client_credentials', client_id: pm.environment.get('client_id'), client_secret: pm.environment.get('client_secret') }) }", "}, (err, res) => {", "  if (err || res.code !== 200) { console.error('Sign-in failed', err || res.text()); return; }", "  const j = res.json();", "  pm.environment.set('access_token', j.access_token);", "  pm.environment.set('token_expires', String(Date.now() + j.expires_in * 1000));", "});"]}}], "variable": [{"key": "base_url", "value": "https://app.yaqinerp.com/api/shipping/v1"}], "item": [{"name": "1. Sign in", "item": [{"name": "Get access token", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}], "url": {"raw": "{{base_url}}/oauth/token", "host": ["{{base_url}}"], "path": ["oauth", "token"]}, "description": "Not needed by hand: the collection signs in by itself before each request. Use it to check the credentials.", "body": {"mode": "raw", "raw": "{\n  \"grant_type\": \"client_credentials\",\n  \"client_id\": \"{{client_id}}\",\n  \"client_secret\": \"{{client_secret}}\"\n}", "options": {"raw": {"language": "json"}}}, "auth": {"type": "noauth"}}, "event": [{"listen": "test", "script": {"type": "text/javascript", "exec": ["const j = pm.response.json();", "pm.test('token', () => pm.expect(j.access_token).to.be.a('string'));", "pm.environment.set('access_token', j.access_token);", "pm.environment.set('token_expires', String(Date.now() + j.expires_in * 1000));"]}}]}, {"name": "Ping", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/ping", "host": ["{{base_url}}"], "path": ["ping"]}, "description": ""}}, {"name": "Statuses", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/statuses", "host": ["{{base_url}}"], "path": ["statuses"]}, "description": "", "auth": {"type": "noauth"}}}]}, {"name": "2. Shipments", "item": [{"name": "List new shipments", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/shipments?state=new&limit=50", "host": ["{{base_url}}"], "path": ["shipments"], "query": [{"key": "state", "value": "new"}, {"key": "limit", "value": "50"}]}, "description": "Shipments waiting for you. The first one is kept in {{shipment_id}} for the next requests."}, "event": [{"listen": "test", "script": {"type": "text/javascript", "exec": ["const j = pm.response.json();", "pm.test('200 OK', () => pm.response.to.have.status(200));", "if (j.data && j.data.length) { pm.environment.set('shipment_id', j.data[0].id); console.log('shipment_id = ' + j.data[0].id); }"]}}]}, {"name": "List all shipments updated since", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/shipments?updated_since=2026-11-01T00:00:00+03:00", "host": ["{{base_url}}"], "path": ["shipments"], "query": [{"key": "updated_since", "value": "2026-11-01T00:00:00+03:00"}]}, "description": ""}}, {"name": "Get shipment", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}"]}, "description": ""}}, {"name": "Accept", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/accept", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "accept"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"tracking_number\": \"TRK{{$timestamp}}\",\n  \"label_url\": \"https://example.com/labels/TRK.pdf\",\n  \"estimated_delivery\": \"2026-11-10\"\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "Reject", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/reject", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "reject"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"reason\": \"Out of our coverage area\"\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "Replace label", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/label", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "label"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"label_url\": \"https://example.com/labels/TRK-v2.pdf\"\n}", "options": {"raw": {"language": "json"}}}}}]}, {"name": "3. Tracking", "item": [{"name": "Picked up", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/events", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "events"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"status\": \"PICKED_UP\",\n  \"location\": {\n    \"city\": \"Riyadh\"\n  }\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "Out for delivery", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/events", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "events"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"status\": \"OUT_FOR_DELIVERY\",\n  \"note\": \"Driver Ahmed 0550000000\"\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "Delivery attempt failed", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/events", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "events"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"status\": \"DELIVERY_ATTEMPT_FAILED\",\n  \"note\": \"Customer not answering\"\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "Delivered (proof of delivery)", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/events", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "events"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"status\": \"DELIVERED\",\n  \"proof_of_delivery\": {\n    \"receiver_name\": \"Mohammed\",\n    \"photo_url\": \"https://example.com/pod/1.jpg\"\n  },\n  \"cod_collected\": 115\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "History", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/events", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "events"]}, "description": ""}}, {"name": "Add a charge", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/shipments/{{shipment_id}}/charges", "host": ["{{base_url}}"], "path": ["shipments", "{{shipment_id}}", "charges"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"type\": \"shipping\",\n  \"amount\": 25.3,\n  \"currency\": \"SAR\"\n}", "options": {"raw": {"language": "json"}}}}}]}, {"name": "4. Cash on delivery", "item": [{"name": "Report a COD payout", "request": {"method": "POST", "header": [{"key": "Content-Type", "value": "application/json"}, {"key": "Idempotency-Key", "value": "{{$guid}}"}], "url": {"raw": "{{base_url}}/cod-remittances", "host": ["{{base_url}}"], "path": ["cod-remittances"]}, "description": "", "body": {"mode": "raw", "raw": "{\n  \"reference\": \"PAY-{{$timestamp}}\",\n  \"paid_at\": \"2026-11-15\",\n  \"currency\": \"SAR\",\n  \"bank_reference\": \"SARIE-123\",\n  \"lines\": [\n    {\n      \"shipment_id\": \"{{shipment_id}}\",\n      \"amount\": 115\n    }\n  ]\n}", "options": {"raw": {"language": "json"}}}}}, {"name": "List COD payouts", "request": {"method": "GET", "header": [], "url": {"raw": "{{base_url}}/cod-remittances", "host": ["{{base_url}}"], "path": ["cod-remittances"]}, "description": ""}}]}]}