Returns

Initiate a new return merchandise authorization (RMA) object in Glopal's shipping system with below API. The return processing can be immediately initiated in which case the generated return label and shipping documents will be returned in the API response.

Create RMA (return) entity

post

https://ws.xport.glopalservice.comhttps://ws.stg.xport.glopalservice.com

/order/authorization

Header parameters

x-loginstringRequired

Client username (set by Glopal)

Example: usernamePattern: ^[a-z0-9\-]{3,255}$

x-aliasstringOptional

Optional system username to enable separation of authentication credentials by integrated client system. (set by Glopal)

Example: alias-usernamePattern: ^[a-z0-9\-]{3,50}$

x-signaturestringRequired

The authentication signature is created by using the concatenation of the login, the ‘@’ sign and the timestamp, transformed into a HMAC_256 signature using your secret access key.

Example: 40b976b35a08bb951439ea7bbfa0a7bd73dab7c813399a31d9d1a157bc08929bPattern: ^[0-9a-f]{64}$

x-timestampnumber · floatRequired

The authentication timestamp must be a decimal numeric representing the current POSIX time, extended to microsecond accuracy. If the requesting system does not provide high-resolution time, it is advised to use a 6-digit random number. It is important to have the requesting system synchronised with a reliable time source (f.i. a stratum 2 NTP server) to avoid request rejection.

Example: 1680010295.775523Pattern: ^[12]\d{9}\.\d{6}$

x-versionnumber · floatOptionalDefault: 0.68Pattern: (^0\.\d{2}$|^[1-9]\d*\.\d{2}$)

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not found

application/jsonapplication/xml

405

Method not allowed

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

503

Service unavailable

application/jsonapplication/xml

post

/order/authorization

HTTPcURLJavaScriptPython

POST /order/authorization HTTP/1.1
Host: ws.xport.glopalservice.com
x-login: username
x-signature: 40b976b35a08bb951439ea7bbfa0a7bd73dab7c813399a31d9d1a157bc08929b
x-timestamp: 1680010295.775523
Content-Type: application/json
Accept: */*
Content-Length: 757

{
  "order_reference": "test123",
  "hub_code": "TRT",
  "email": "[email protected]",
  "phone": 12345678919,
  "payment": {
    "payer": "customer",
    "full_payment": 1,
    "flat_fee": 1
  },
  "rma_number": "RMA_232_er",
  "notes": "Return note about the specifics of return request",
  "full_return": 1,
  "immediate_return": 1,
  "fulfillment_id": "FU.123OMS",
  "wms_id": "WMS12345",
  "pickup_address": {
    "name": "Test Testington",
    "user_reference": "testref",
    "address1": "Test street 1",
    "address2": "Second floor",
    "address3": "Room 37",
    "postcode": 90210,
    "state": "CA",
    "city": "Beverly Hills",
    "country": "US",
    "service_point_reference": "SDF_hub_rr1234",
    "company": "Test company",
    "vat_number": "T12344434",
    "email": "[email protected]",
    "phone": 12345678919
  },
  "item": [
    {
      "qty": 1,
      "gtin": 1234567890,
      "merchant_sku": 1234567890,
      "discounted_price": 1
    }
  ]
}

{
  "return_id": "642edad40de2f361ba4d1684aaf3c53a0afc687b",
  "immediate_return": {
    "carrier_name": "CARRIER",
    "awb": "AWB1234567890_23",
    "tracking_url": "https://test.xport.glopalservice.com/test",
    "carrier_tracking_url": "https://test.xport.glopalservice.com/test",
    "is_paperless": 1,
    "label_file_zpl": "document/example.zpl",
    "label_file_pdf": "document/example.pdf",
    "advice_file_pdf": "document/example.pdf",
    "combined_doc_file_pdf": "document/example.pdf",
    "label_url_zpl": "https://test.xport.glopalservice.com/test",
    "label_url_pdf": "https://test.xport.glopalservice.com/test",
    "advice_url_pdf": "https://test.xport.glopalservice.com/test",
    "combined_doc_url_pdf": "https://test.xport.glopalservice.com/test",
    "label_dpi_density": 300,
    "label_type": "BL4x6"
  },
  "error": 0,
  "errors": [
    {
      "code": "ISSUE_CODE",
      "details": "Issue description",
      "field": "field"
    }
  ],
  "warnings": [
    {
      "code": "ISSUE_CODE",
      "details": "Issue description",
      "field": "field"
    }
  ]
}