Skip to main content

Documentation Portal

Order_GetShippingDocuments

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://connect-qa.bglobale.com:443/Order/GetShippingDocuments");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
headers = curl_slist_append(headers, "accept: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"HubCode\":\"string\",\"OrderId\":\"string\",\"MerchantOrderId\":\"string\",\"DeliveryReferenceNumber\":\"string\",\"IsCompleted\":true,\"Parcels\":[{\"Products\":[],\"TrackingDetails\":{},\"ParcelCode\":\"string\"}],\"Exceptions\":[{\"CartItemId\":\"string\",\"ProductCode\":\"string\",\"ExceptionType\":1,\"ExpectedFulfilmentDate\":\"2019-08-24T14:15:22Z\",\"Quantity\":0}],\"TrackingDetails\":{\"TrackingNumber\":\"string\",\"TrackingURL\":\"string\",\"ShipperName\":\"string\"}}");

CURLcode ret = curl_easy_perform(hnd);
package main

import (
    "fmt"
    "strings"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "http://connect-qa.bglobale.com:443/Order/GetShippingDocuments"

    payload := strings.NewReader("{\"HubCode\":\"string\",\"OrderId\":\"string\",\"MerchantOrderId\":\"string\",\"DeliveryReferenceNumber\":\"string\",\"IsCompleted\":true,\"Parcels\":[{\"Products\":[],\"TrackingDetails\":{},\"ParcelCode\":\"string\"}],\"Exceptions\":[{\"CartItemId\":\"string\",\"ProductCode\":\"string\",\"ExceptionType\":1,\"ExpectedFulfilmentDate\":\"2019-08-24T14:15:22Z\",\"Quantity\":0}],\"TrackingDetails\":{\"TrackingNumber\":\"string\",\"TrackingURL\":\"string\",\"ShipperName\":\"string\"}}")

    req, _ := http.NewRequest("POST", url, payload)

    req.Header.Add("content-type", "application/json")
    req.Header.Add("accept", "application/json")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://connect-qa.bglobale.com:443/Order/GetShippingDocuments")
  .header("content-type", "application/json")
  .header("accept", "application/json")
  .body("{\"HubCode\":\"string\",\"OrderId\":\"string\",\"MerchantOrderId\":\"string\",\"DeliveryReferenceNumber\":\"string\",\"IsCompleted\":true,\"Parcels\":[{\"Products\":[],\"TrackingDetails\":{},\"ParcelCode\":\"string\"}],\"Exceptions\":[{\"CartItemId\":\"string\",\"ProductCode\":\"string\",\"ExceptionType\":1,\"ExpectedFulfilmentDate\":\"2019-08-24T14:15:22Z\",\"Quantity\":0}],\"TrackingDetails\":{\"TrackingNumber\":\"string\",\"TrackingURL\":\"string\",\"ShipperName\":\"string\"}}")
  .asString();
const data = JSON.stringify({
  "HubCode": "string",
  "OrderId": "string",
  "MerchantOrderId": "string",
  "DeliveryReferenceNumber": "string",
  "IsCompleted": true,
  "Parcels": [
    {
      "Products": [],
      "TrackingDetails": {},
      "ParcelCode": "string"
    }
  ],
  "Exceptions": [
    {
      "CartItemId": "string",
      "ProductCode": "string",
      "ExceptionType": 1,
      "ExpectedFulfilmentDate": "2019-08-24T14:15:22Z",
      "Quantity": 0
    }
  ],
  "TrackingDetails": {
    "TrackingNumber": "string",
    "TrackingURL": "string",
    "ShipperName": "string"
  }
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://connect-qa.bglobale.com:443/Order/GetShippingDocuments");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("connect-qa.bglobale.com:443")

payload = "{\"HubCode\":\"string\",\"OrderId\":\"string\",\"MerchantOrderId\":\"string\",\"DeliveryReferenceNumber\":\"string\",\"IsCompleted\":true,\"Parcels\":[{\"Products\":[],\"TrackingDetails\":{},\"ParcelCode\":\"string\"}],\"Exceptions\":[{\"CartItemId\":\"string\",\"ProductCode\":\"string\",\"ExceptionType\":1,\"ExpectedFulfilmentDate\":\"2019-08-24T14:15:22Z\",\"Quantity\":0}],\"TrackingDetails\":{\"TrackingNumber\":\"string\",\"TrackingURL\":\"string\",\"ShipperName\":\"string\"}}"

headers = {
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/Order/GetShippingDocuments", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("http://connect-qa.bglobale.com:443/Order/GetShippingDocuments")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"HubCode\":\"string\",\"OrderId\":\"string\",\"MerchantOrderId\":\"string\",\"DeliveryReferenceNumber\":\"string\",\"IsCompleted\":true,\"Parcels\":[{\"Products\":[],\"TrackingDetails\":{},\"ParcelCode\":\"string\"}],\"Exceptions\":[{\"CartItemId\":\"string\",\"ProductCode\":\"string\",\"ExceptionType\":1,\"ExpectedFulfilmentDate\":\"2019-08-24T14:15:22Z\",\"Quantity\":0}],\"TrackingDetails\":{\"TrackingNumber\":\"string\",\"TrackingURL\":\"string\",\"ShipperName\":\"string\"}}"

response = http.request(request)
puts response.read_body
Body parameter
{
  "HubCode": "string",
  "OrderId": "string",
  "MerchantOrderId": "string",
  "DeliveryReferenceNumber": "string",
  "IsCompleted": true,
  "Parcels": [
    {
      "Products": [],
      "TrackingDetails": {},
      "ParcelCode": "string"
    }
  ],
  "Exceptions": [
    {
      "CartItemId": "string",
      "ProductCode": "string",
      "ExceptionType": 1,
      "ExpectedFulfilmentDate": "2019-08-24T14:15:22Z",
      "Quantity": 0
    }
  ],
  "TrackingDetails": {
    "TrackingNumber": "string",
    "TrackingURL": "string",
    "ShipperName": "string"
  }
}
HubCode: string
OrderId: string
MerchantOrderId: string
DeliveryReferenceNumber: string
IsCompleted: true
Parcels:
  - Products: []
    TrackingDetails: {}
    ParcelCode: string
Exceptions:
  - CartItemId: string
    ProductCode: string
    ExceptionType: 1
    ExpectedFulfilmentDate: 2019-08-24T14:15:22Z
    Quantity: 0
TrackingDetails:
  TrackingNumber: string
  TrackingURL: string
  ShipperName: string
<?xml version="1.0" encoding="UTF-8" ?>
<GlobalE.Model.API.Merchant.ParameterClasses.UpdateOrderDispatchRequest>
  <HubCode>string</HubCode>
  <OrderId>string</OrderId>
  <MerchantOrderId>string</MerchantOrderId>
  <DeliveryReferenceNumber>string</DeliveryReferenceNumber>
  <IsCompleted>true</IsCompleted>
  <Parcels>
    <TrackingDetails/>
    <ParcelCode>string</ParcelCode>
  </Parcels>
  <Exceptions>
    <CartItemId>string</CartItemId>
    <ProductCode>string</ProductCode>
    <ExceptionType>1</ExceptionType>
    <ExpectedFulfilmentDate>2019-08-24T14:15:22Z</ExpectedFulfilmentDate>
    <Quantity>0</Quantity>
  </Exceptions>
  <TrackingDetails>
    <TrackingNumber>string</TrackingNumber>
    <TrackingURL>string</TrackingURL>
    <ShipperName>string</ShipperName>
  </TrackingDetails>
</GlobalE.Model.API.Merchant.ParameterClasses.UpdateOrderDispatchRequest>
Parameters

Name

In

Type

Required

Description

body

body

GlobalE.Model.API.Merchant.ParameterClasses.UpdateOrderDispatchRequest

true

none

» HubCode

body

string

false

none

» OrderId

body

string

false

none

» MerchantOrderId

body

string

false

none

» DeliveryReferenceNumber

body

string

false

none

» IsCompleted

body

boolean

false

none

» Parcels

body

[GlobalE.Model.API.ParcelProductInformation]

false

none

»» Products

body

[GlobalE.Model.API.Product]

false

none

»»» ProductCode

body

string

false

none

»»» ProductGroupCode

body

string

false

none

»»» Name

body

string

false

none

»»» NameEnglish

body

string

false

none

»»» Keywords

body

string

false

none

»»» URL

body

string

false

none

»»» Description

body

string

false

none

»»» DescriptionEnglish

body

string

false

none

»»» GenericHSCode

body

string

false

none

»»» Weight

body

string

false

none

»»» Height

body

string

false

none

»»» Length

body

string

false

none

»»» Width

body

string

false

none

»»» Volume

body

string

false

none

»»» ImageURL

body

string

false

none

»»» ImageWidth

body

string

false

none

»»» ImageHeight

body

string

false

none

»»» OriginCountryCode

body

string

false

none

»»» ListPrice

body

string

false

none

»»» OriginalListPrice

body

string

false

none

»»» SalePrice

body

string

false

none

»»» OriginalSalePrice

body

string

false

none

»»» UnitSalePriceForDuties

body

string

false

none

»»» SalePriceBeforeRounding

body

string

false

none

»»» OriginalSalePriceAfterGlobalEDiscount

body

string

false

none

»»» OriginalSalePriceAfterRounding

body

string

false

none

»»» VATRateType

body

GlobalE.Model.API.VATRateType

false

none

»»»» VATRateTypeCode

body

string

false

none

»»»» Name

body

string

false

none

»»»» Rate

body

number(double)

false

none

»»»» InternalVATRateTypeId

body

integer(int64)

false

none

»»» LocalVATRateType

body

GlobalE.Model.API.VATRateType

false

none

»»» Brand

body

GlobalE.Model.API.Brand

false

none

»»»» BrandCode

body

string

false

none

»»»» Name

body

string

false

none

»»» Categories

body

[GlobalE.Model.API.Category]

false

none

»»»» CategoryCode

body

string

false

none

»»»» Name

body

string

false

none

»»» OrderedQuantity

body

integer(int64)

false

none

»»» DeliveryQuantity

body

integer(int32)

false

none

»»» CartItemId

body

string

false

none

»»» ParentCartItemId

body

string

false

none

»»» CartItemOptionId

body

string

false

none

»»» IsBlockedForGlobalE

body

boolean

false

none

»»» IsBundle

body

boolean

false

none

»»» Attributes

body

[GlobalE.Model.API.ProductAttribute]

false

none

»»»» AttributeCode

body

string

false

none

»»»» Name

body

string

false

none

»»»» AttributeTypeCode

body

string

false

none

»»» AttributesEnglish

body

[GlobalE.Model.API.ProductAttribute]

false

none

»»» MetaData

body

GlobalE.Model.API.ProductMetaData

false

none

»»»» Attributes

body

[GlobalE.Model.API.CustomProductAttribute]

false

none

»»»»» AttributeKey

body

string

false

none

»»»»» AttributeValue

body

string

false

none

»»» IsFixedPrice

body

boolean

false

none

»»» HandlingCode

body

string

false

none

»»» NetWeight

body

number(double)

false

none

»»» NetVolume

body

number(double)

false

none

»»» IsVirtual

body

boolean

false

none

»»» ProductGroupCodeSecondary

body

string

false

none

»»» ProductCodeSecondary

body

string

false

none

»»» GiftMessage

body

string

false

none

»»» OriginalMerchantUnitSalePrice

body

string

false

none

»»» VATCategory

body

GlobalE.Model.API.VATCategory

false

none

»»»» VATCategoryCode

body

string

false

none

»»»» Name

body

string

false

none

»»» IsBackOrdered

body

boolean

false

none

»»» BackOrderDate

body

string(date-time)

false

none

»»» ProductClassCode

body

string

false

none

»»» PriceCoefficientRate

body

number(double)

false

none

»»» IsGiftCard

body

boolean

false

none

»»» GiftCardId

body

string

false

none

»» TrackingDetails

body

GlobalE.Model.API.Merchant.TrackingDetails

false

none

»»» TrackingNumber

body

string

false

none

»»» TrackingURL

body

string

false

none

»»» ShipperName

body

string

false

none

»» ParcelCode

body

string

false

none

» Exceptions

body

[GlobalE.Model.API.Merchant.ParameterClasses.UpdateOrderDispatchException]

false

none

»» CartItemId

body

string

false

none

»» ProductCode

body

string

false

none

»» ExceptionType

body

integer(int32)

false

none

»» ExpectedFulfilmentDate

body

string(date-time)

false

none

»» Quantity

body

integer(int64)

false

none

» TrackingDetails

body

GlobalE.Model.API.Merchant.TrackingDetails

false

none

Enumerated Values

Parameter

Value

»» ExceptionType

1

»» ExceptionType

2

Responses

Status

Meaning

Description

Schema

200

OK

OK

System.Object

This operation does not require authentication