search

printdotio / printio-api

Issues + wiki for the api. See http://print.io/api
0 stars 0 forks source link

Explanation of parameters #13

Closed chrischen closed 9 years ago

chrischen commented 9 years ago

Can I get a description of which parameters are optional? Also, a description of some of the non-self-explanatory parameters.

Specifically, what are ThumbnailUrl": "string", "ManipCommand": "string", "SpaceId": "string", and "SourceId"

Is ThumbnailUrl optional?

Thanks

{
  "ShipToAddress": {
    "FirstName": "string",
    "LastName": "string",
    "Line1": "string",
    "Line2": "string",
    "City": "string",
    "State": "string",
    "CountryCode": "string",
    "PostalCode": "string",
    "IsBusinessAddress": "boolean",
    "Phone": "string",
    "Email": "string"
  },
  "BillingAddress": {
    "FirstName": "string",
    "LastName": "string",
    "Line1": "string",
    "Line2": "string",
    "City": "string",
    "State": "string",
    "CountryCode": "string",
    "PostalCode": "string",
    "IsBusinessAddress": "boolean",
    "Phone": "string",
    "Email": "string"
  },
  "Items": [
    {
      "Quantity": "integer",
      "SKU": "string",
      "ShipCarrierMethodId": "integer",
      "ShipType": "string",
      "Images": [
        {
          "Url": "string",
          "Index": "integer",
          "ThumbnailUrl": "string",
          "ManipCommand": "string",
          "SpaceId": "string"
        }
      ],
      "SourceId": "string"
    }
  ],
  "Payment": {
    "BraintreeEncryptedCCNumber": "string",
    "BraintreeEncryptedCCExpDate": "string",
    "BraintreeEncryptedCCV": "string",
    "PartnerBillingKey": "string",
    "Total": "decimal",
    "CurrencyCode": "string"
  },
  "SourceId": "string",
  "IsPreSubmit": "boolean",
  "CouponCode": "string",
  "Meta": {
    "Key": "string",
    "Value": "string"
  }
}
chrischen commented 9 years ago

And does /orders support multiple "Items" in the array with the same SKU?

micahasmith commented 9 years ago

optional/reqd is spelled out here: http://print.io/api#orders-api

all the fields you mentioned are for advanced scenarios. if you're planning on passing image urls (as 99% of our customers do) then you won't need them